innovaphone wiki - User contributions [en]

Reference:Device Health Check

2017-02-23T12:15:47Z

Tle: /* Finding a CPU Hog */

==Applies To==
This information applies to

* all innovaphone devices



==More Information==

This article advises how to perform a quick ''health check'' on an innovaphone device. This may serve as guidance for routine checking of a PBX systems state as well as to start debugging when a device malfunctions.

===Overview===

To perform a device health check, the following steps are recommended

* Inspect the device alarm table
* Inspect the device event list
* Inspect performance counters
* Check volatile memory (RAM) usage
* Check CPU usage
* Check persistent memory (Flash) usage
* Check CF card usage
* Examine system log
* Check for efficient PBX configuration

Depending on the device type, some of the steps may or may not apply.

=== The Alarm Table ===
The systems [[Reference8:Administration/Diagnostics/Alarms|alarm table]] available under ''Administration/Diagnostics/Alarms'' should always be empty. If there are entries in it, examine them carefully and fix the problem so that the alarms disappears. The reason for this is pretty simple: if the alarm table is filled with entries that you already have checked but considered ''acceptable'', then it will not take long until a severe problem will hide itself in between the harmless entries. So make it a habit that your alarm table is empty always.

The alarms have a ''details page'' available in the ''Code'' columns. These sometimes show useful further information. Also, many of the error codes have a dedicated wiki help page, available through the details page ''Help'' button.

=== The Event List ===
The systems [[Reference8:Administration/Diagnostics/Events|events list]] available under ''Administration/Diagnostics/Events'' may contain a fair amount of entry types. As opposed to the alarm table, where the entry is removed when the problem is fixed, entries in the event list are not removed (except the list exceeds its allowable size in which case the oldest entries will be removed). As a result, your event list will likely rarely be empty. You need to work through the list and analyse each entry to determine if or if not it is still relevant. To avoid analysing entries again and again, you can clear the whole list when finished, or (from V8 on), you can declare it as ''already taken care of'' using the ''Mark'' button in the detail page (which will render the entries ''Code'' column in green instead of red).

As for alarms, it is important to take care of problems which frequently create entries in the event list, as otherwise you will most likely overlook severe problems in a crowded event list.

=== The Calls Screen ===
One important issue is consistently good voice quality. In a life system, you can do a quick check on voice quality simply by looking at the PBX's [[Reference:Administration/PBX/Calls | Administration/PBX/Calls ]] screen.

<pre>
Number Name Protocol Media Dir Number Name Protocol Media Uptime State
13 abc H323EFC:TRANSIT G711A (2,0,0) x >> 001730 H323EFC:TRANSIT G711A (2,0,0) x 0d 0h 29m 31s Connected SRTP
0017200 H323EFC:TRANSIT G711A (46,5,3) >> 37 cba H323EFC:TRANSIT G711A (39,8,29) 0d 0h 7m 2s Connected
</pre>

Have an eye on the values within round parentheses in the ''Media'' column, most notably the third ''packet loss'' value. These should be low, more than 5/minute for ''packet loss'' e.g. is a good reason to be worried (so in our example, the second call is still acceptable but on the lower end of satisfaction). More information about the call screen can be found in [[Howto:How_to_read_the_call_screen | How to read the call screen]].

==== Recent Call Data ====
While the calls screen is a good tool to see how your calls feel like right now, they do not allow you to review data for terminated calls. A rule of thumb however says that everything is fine as long as you look at it, but gets worse as soon as your end customers are left alone with the system. A nice tool to get at past data easily is the internal [[ Reference7:Administration/Gateway/CDR0 | Administration/Gateway/CDR0 ]] CDR logging. You can save call detail records on your local CF card (using the <code>LOCAL</code> ''Log Server Type'' which will save them to <code>/DRIVE/CF0/log/CDR*.txt</code>. You can open these files with any text editor and although they look a bit strange, you can search straight for entries like <code>&xcoder=G711A,30(0,10,0)&rcoder=G711A,30(0,0,0)</code>. The values in parentheses have the same meaning as in the PBX's calls screen.

=== The Performance Counters ===
The systems [[Reference8:Administration/Diagnostics/Counters | performance counters ]] available under ''Administration/Diagnostics/Counters'' are another valuable tool to determine its health status. These are graphs which show the status of certain resource over the last 24 hours (8 hours are shown, you can scroll through time using the arrow buttons). Each individual value on the x-axis is a 2-minutes average. Lets have look at the resource counters currently available:

==== CPU ====
This counter shows the total CPU usage. A system that runs near to 100% all the time is a candidate for unpleasant behaviour, obviously. However, running on 100% simply says that things are getting slow. It does not necessarily say that things don't work. But as a rule of life, demand is always increasing, not decreasing, so there are two options in such a situation:
* be prepared for an upgrade
* eliminate the reason for excessive CPU usage
We will discuss in a later section of this article how to determine who the CPU hog is.

We generally recommend to make sure CPU load is not more than two thirds in average. This of course is just a rule of thumb. You may well run with a system with higher load or you may experience problems with a system with lower load. Still, if your system continuously runs with more than 2/3 of its CPU power, you should ask yourself if this is expected behaviour.

Also, watch out for unusual peaks. When you have a system that has a healthy looking CPU load graph, see if there are perhaps thin peaks. These would indicate short time frames with high load. They do not look impressive in the graph, still they may create severely bad user experience. Suppose for example there is a CPU usage pattern which creates 100% CPU load for a minute every once in a while. This would look like a comfortable 50% value in the 2-minutes graph slice. The end user though may experience service outages, signalling time-outs, frustrating response times etc. during this period of time. Such patterns usually look like a sharp ''needle'' in the graph and you should pay attention if you observe such.

==== CPU-R ====
This counter shows the amount of ''reserved CPU'' time. As opposed to the CPU counter, this is not CPU load that actually is used, but CPU performance which needs to be reserved for real-time application. Sending/receiving RTP data is considered real-time, for example. As opposed to, say HTTP access, where missing CPU performance merely makes things running slower, missing CPU performance for transmission of RTP data results in voice drop-outs and thus is considered a failure. This is why calls are rejected right away when no CPU performance can be reserved. When your CPU-R counter runs near to 100% often, then your system is overloaded and needs to be upgraded. Note that real-time apps do not suffer from 100% CPU values though, as the innovaphone operating system features a very efficient real-time prioritization.

==== MEM ====
This counter shows the total volatile memory (RAM) usage. Memory usage is in fact more critical than the CPU usage, as a system with low or no CPU resources left will still run, albeit slowly. A system with no memory resources will stop working and re-boot instead! It is thus crucial to have an eye on memory usage. You may observe that the memory usage graph usually is flat, that is, the value never decreases and rarely increases, especially once the device ran for a while after a re-boot. This is because the memory allocation strategy eventually claims memory for a specific purpose if needed, but never de-allocates it further on. Instead, objects allocated but no longer used are marked as ''free'' and re-used when an object of the same type is needed later on. The memory allocation graph shows all allocated objects, including those which are used and those which are currently free (as they are not available for use by objects of other types).

If memory usage grows steadily, there is most likely a memory leak somehow. That is, a function in the device allocates objects and thus claims memory but fails to mark those objects as free when done. If this happens, each function invocation will result in lost memory and the only way to recover from this situation is to re-boot the system. We will discuss how to track down memory hogs in a later section.

==== PRIx / BRIx ====
These counters show the number of B-channels used on the respective ISDN interfaces. Its interpretation should be fairly straight forward.

=== Finding a CPU Hog ===
In the event that you observe excessive CPU load, you need to find out which function actually consumes it. Once you have done so, you can either try to re-configure the system so that the causing function is used less, or you can add an extra device and move this function to the new device. For example, if you find that your PBX runs out of CPU resources because of heavy load on the system's CF-card, you may want to move the CF card to a different device which has more CPU cycles left.

Unfortunately, you cannot determine which ''function'' takes your CPU cycles away easily. However, you can determine which ''module'' does. In our previous example, you won't be able to determine that it's excessive config save operations on the CF card that produces the load, but you will be able to determine that its the CF card that does.

A ''module'' is a piece of code in the devices firmware that performs a certain task. You can think of it as a ''thread'' in an operating system such as Windows or Linux. ''Modules'' are named and you can retrieve a list of modules currently running on your device using the <code>!mod</code> command. Assuming your device has the IP address 172.16.0.10, you would open [http://172.16.0.10/!mod http://172.16.0.10/!mod] with your browser. You will receive a list of modules such as this one:

[[Image:Debugging_check-list_1.png]]

In this table, the first column (modules) and the second column (ticks) are of interest. The second column shows the number of ticks used by the module since the counters were reset the last time. The system never resets the counters on its own. They will be reset if you add the <code>clr</code> option to the <code>mod</code> command ([http://172.16.0.10/!mod+clr http://172.16.0.10/!mod clr]). A ''tick'' by the way corresponds to some clock-tick found in the devices CPU (platform specific), so be prepared for large values.

For easier analysis, you may want to import this table into your favourite spread sheet application. In Microsoft's Excel (c) for example, you would highlight the whole table, copy it in to your copy&paste buffer, then use ''Inhalte einfügen / Paste Content'' with ''Quelle: Text / Source: Text'' so you get each column in a separate Excel column (you may need to use the ''Import Assistant'' then, later V8 and V9 firmware builds output a more excel friendly table format). After some cleanup (remove unused columns), your spread sheet should then look something like this:

[[Image:Device Health Check - mod-cmd-excel-1.png | Excel Import]]

You can then add a column (column D in our example) which relates the number of ticks used by a module to the total number of ticks used (<code>=B96/($D$98)</code>). This is the relative load imposed by a certain module. Finally, sort the table by this column and you get a list of CPU hog candidates:

[[Image:Device Health Check - mod-cmd-excel-2.png | Excel Analysis]]

Unfortunately, there is no list of ''which module has which name'', but a look at the module name will give a good indication of what it is. The typical scenario is that IP0 (the IP stack), ETHx (the ethernet drivers) and H323 (the H.323 signalling stack) will be on top. If the device is a gateway too, the DSP drivers (AC-DSPx) and SRTP encryption drivers (MV78X00_CRYPT) will be in the top 10 too. In our example, you can see that the compact flash driver (CFLASH) is also prominent. Compared to that, the PBX itself - accounting for 2% of the cycles consumed - is a side-note only in our example.

Be aware that these figures are counted from the last counter reset. To identify the source of a CPU resource problem, you would wait for the situation to happen (i.e. you would wait for a time the CPU usage is high) and then do the math. However, you should start the analysis by resetting the counters (<code>!mod clr</code>), then wait a significant amount of time (half a minute may be a good starter), then get the stats (<code>!mod</code>) and analyse. If you fail to reset the counters, your picture will be distorted as it is influenced by previous (and probably unknown) activity.

=== Finding a DRAM Memory Hog ===

The strategy to find a dram memory hog is pretty much similar to the one to find the CPU hog. However, rather than using the <code>!mod</code> command, you would use the <code>!mem</code> ([http://172.16.0.10/!mem http://172.16.0.10/!mem]) command. The output will look something like this (again, later builds have somewhat different layout, so excel import will be easier):

<pre>
Total Memory Usage = 1061428
name size used free usage
client_gui_button 64 0 0 0
client_gui_text 64 0 0 0
client_gui_break 60 0 0 0
client_gui_ruler 60 0 0 0
client_gui_list_element 60 0 0 0
client_gui_list 64 0 0 0
client_gui_table_cell 60 0 0 0
client_gui_table_row 60 0 0 0
client_gui_table 60 0 0 0
</pre>

The table has a line for each type of internal object (e.g. <code>client_gui_button</code>). The ''size'' column gives the size of a single instance, the ''used'' and ''free'' columns the number of allocated objects which are still in use or free for re-use again, while ''usage'' is <code>size * (used + free)</code>. So clearly, the ''usage'' column is what you are interested in. Again, we will do some spread-sheet math.

[[Image:Device Health Check - mem-cmd-excel-1.png | Excel Analysis]]

In our example, we relate the values in the ''usage'' column to the total allocatable memory size (column G) and the currently allocated memory (column F). The table is then sorted by column F, resulting in a list of memory using objects.

As for the modules, there is no ''which object type has which name'' list, but looking at the object names will give some indication on what kind of object it is and which function it may be related to. The screen-shot was taken from an idle system, this is why column G is all zero. In a life system, the result may look more like this:

<pre>
Name Size Used Free Sum % of allocated %of available
cmd_exec 376 36 74 41360 1% 0%
flashdir_item 120 418 0 50160 1% 0%
pbx_connector 508 67 47 57912 2% 0%
h323_call 552 67 46 62376 2% 0%
gk_map 448 176 1 79296 2% 0%
tcp_socket 408 150 176 133008 4% 0%
pbx_user 584 270 0 157680 4% 0%
packet 52 4997 488 285220 8% 0%
http_request 5472 33 75 590976 17% 0%
buffer 32 10437 8255 598144 17% 0%
ac_491 122648 6 0 735888 21% 0%
</pre>

As a rule of thumb, many systems tend to run out of CPU more likely than out of DRAM memory.

''packet'' and ''buffer'' are special, as they do not relate to a specific function. Whenever the system needs temporary, short lived memory - e.g. to carry a network packet - it will allocate a ''packet'' that carries one or more ''buffers''. Peak network load thus will allocate a huge amount of ''packets'' and ''buffers'' which might not be used again but still consume memory. When the number of ''packets'' or ''buffers'' increases over time, this is most likely an indication of a memory leak.

The bottom of the memory table includes a number of lines as follows:

<pre>
allocated: 1466608
free for malloc: 58580
total malloc space: 3149356
physcial memory: 8388608
Total memory usage: 3090776
Memory Load: 36%
</pre>

The ''allocated:'' line is the number of allocated objects. That is, the sum of the ''usage'' column. Please note that this include all free objects of a specific type, which can be used for allocation of new objects of this type.

The ''free for malloc:'' line is the amount of memory which can be allocated from. This will be used whenever an object is needed for which there is no previously allocated but now unused object space (as shown in the ''free'' column).

The ''total malloc space:'' is the value of ''free for malloc:'' when the system has booted.

The ''Total memory usage:'' is the memory already claimed from the malloc space (that is ''total malloc space:'' minus ''free for malloc''). It does ''not'' include static memory use such as decompressed firmware, stack, etc.

The ''Memory Load:'' finally relates the ''Total memory usage:'' to the ''physical memory:''. Please note though that the box will run out of memory as soon as ''free for malloc'' goes down to zero! It might be useful thus to relate ''free for malloc:'' to ''total malloc space:'', which is exactly what the ''MEM'' counter in ''Administration/Diagnostics'' displays.

==== Obtaining more Information about used Objects ====
Sometimes, object types - even though their meaning is pretty clear - cannot be related to functions easily. For example, if you see an entry like

<pre>
tcp_socket 376 15 64 29704
</pre>

it tells you that a number of sockets are used, but not what for. To see details of an object, some object types support the <code>mem-info</code> method. You would look at the detail properties of the objects of a certain type using e.g. <code>http//172.16.0.10/!mem info tcp_socket</code> ([http://172.16.0.10/!mem+info+tcp_socket http//172.16.0.10/!mem info tcp_socket]). The result list

<pre>
0(c0e09a0c): NAT_LISTEN: ports=0:0, state=0:INIT, ostate=5680, x-q=0, r-q=0
1(c0e1073c): PCAP_SOCK_LISTEN: ports=2002:0, state=0:INIT, ostate=0, x-q=0, r-q=0
2(c0e17174): HTTP_LISTEN: ports=80:0, state=0:INIT, ostate=0, x-q=0, r-q=0
3(c0e173d8): HTTPS_LISTEN: ports=443:0, state=0:INIT, ostate=23130, x-q=0, r-q=0
4(c0e181b8): T_USER: ports=23:0, state=0:INIT, ostate=0, x-q=0, r-q=0
5(c0e1fcd8): LSRV_SOCK_LISTEN: ports=389:0, state=0:INIT, ostate=0, x-q=0, r-q=0
6(c0e718f4): GK-LISTEN: ports=2049:0, state=0:INIT, ostate=-16053, x-q=0, r-q=0
7(c0e71b54): GK-LISTEN: ports=2050:0, state=0:INIT, ostate=0, x-q=0, r-q=0
8(c0e71e3c): GK-LISTEN: ports=2051:0, state=0:INIT, ostate=0, x-q=0, r-q=0
9(c0e72310): GK-LISTEN: ports=2052:0, state=0:INIT, ostate=0, x-q=0, r-q=0
10(c0e725f8): GK-LISTEN: ports=2053:0, state=0:INIT, ostate=1950, x-q=0, r-q=0
11(c0e728e0): GK-LISTEN: ports=2054:0, state=0:INIT, ostate=-16148, x-q=0, r-q=0
12(c0e72bc8): H323_LISTEN: ports=1720:0, state=0:INIT, ostate=-16027, x-q=0, r-q=0
</pre>

may include some useful hints. This is particularly useful for the ''packet'' data structure, as it is used by all classes: [http://172.16.0.10/!mem+info+packet http//172.16.0.10/!mem info packet] indicates the packet creator module:

<pre>
5717(c1d1d0b8): ETHIF,c0078b38 len=31
5719(c18197fc): H323_OUT,c0078b38 len=31
5725(c1cfb864): H323_ACCEPT,c0078b38 len=31
5728(c1d04670): ETHIF,c0078b38 len=31
5729(c1d56ac8): HTTP4_REQUEST,c00e228c len=113
5730(c1f09518): HTTP_SOCKET,c0078b38 len=240
</pre>

If there is a memory leak, the module causing it can easily be spotted.

==== Buffers ====
So far we have talked about ''objects'' in the operating system. However, there are also other users of dynamically allocated memory, the so-called ''buffers''. These are used for network packets for example. You can use <code>http://172.16.0.10/!buf</code> to get a list of used buffers.

<pre>
pool used free
0: 32 4129 2573 375312
1: 64 319 652 85448
2: 128 154 218 56544
3: 256 188 85 76440
4: 512 155 167 172592
5: 1024 24 6 31440
6: 2048 0 1 2072
7: 4096 120 4 510880
8: 8192 2 4 49296
1360024
</pre>

The second column shows the buffer size (buffers are always allocated in multiple-of-2 sizes). To see who has allocated the buffers, you can issue <code>http://172.16.0.10/!buf info size</code> where ''size'' is the one of the valid buffer sizes (32 to 8192).

<pre>
http://172.16.0.10/!buf info 8192
15c6e80: c=HTTP4_REQUEST(114988)
15c4e60: c=HTTP_GET(19838c)
15e8650: c=HTTP_GET(1983a0)
</pre>

This example shows that 3 buffers of size 8192 are used and all are somehow related to HTTP GET requests.

=== Finding a Flash Memory Hog ===
Unfortunately, there is no counter graph for flash memory usage. Still, there is a statistics page as for CPU and DRAM memory. It is retrieved using the <code>!mod cmd FLASHMAN0 info</code> command ([http://172.16.0.10/!mod+cmd+FLASHMAN0+info http://172.16.3.63/!mod cmd FLASHMAN0 info]):

<pre>
bottom 0xfe020000 base 0xfe020000 top 0xfffc0000 segsize 0x20000 segments 253
LDAP - used 128k avail 92k owned 1152k (max 3200k)
VARS - used 67k avail 95k owned 256k (max 256k)

0 0xfe020000 free(0x00) owner MINI(0x09) magic 0x666d order 0x00020031 usage 0x00000001
...
7 0xfe100000 free(0x00) owner FIRM(0x08) magic 0x666d order 0x0002002f usage 0x00000001
...
226 0xffc60000 free(0xff) owner 255 (0xff) magic 0xffff order 0xffffffff usage 0xffffffff
...
230 0xffce0000 used(0x80) owner VARS(0x06) magic 0x666d order 0x00000008 usage 0x00000001
231 0xffd00000 used(0x80) owner LDAP(0x04) magic 0x666d order 0x00000009 usage 0x00000001
</pre>

This table shows all allocated flash memory segments. Users include:
; MINI : the mini (rescue) firmware
; FIRM : the real firmware
; VARS : the storage for non-volatile configuration parameters
; LDAP : the directory storage (holds the PBX object configuration as well as call lists and personal user directories)

Each flash memory user has a fixed maximum quota. In our example, LDAP has set a maximum of 3200kB of which 1152kB are already claimed. In the current active flash segment (that is, the segment which is used to satisfy subsequent memory requests), 92kB are left for allocation. For the VARS flash user, all possible segments are claimed already (256kB of 256kB) and 95kB are left for allocation.

==== Wasting Memory by deleting Objects ====
When PBX objects are deleted, the GUID is kept in flash memory for a while with a note that the object has been deleted. This looks something like <code>mod cmd FLASHDIR0 add-item 101 (cn=object that will be deleted soon)(isDeleted=true)(guid;bin=3886C5ABE909D3119475009033290009)(usn=18243)</code>. Note that this sample entry still takes approximately 110 bytes flash memory. If you experience lack of flash memory and see lots of such entries, you might want to save the devices config, remove the lines with <code>(isDeleted=true)</code> and re-load the config to get rid of these entries. This typically happens when you turn on a new replication for a box that had a large PBX configuration before. These now obsolete PBX entries will be deleted from the configuration when the replication takes place.

=== Finding a Compact Flash Hog ===
Compact flash card space can easily be examined using the ''Info'' button available in [[ Reference7:Administration/Diagnostics/CF | Administration/Diagnostics/CF (up to V8) ]] or [[ Reference9:General/Compact-Flash/General | Reference9:General/Compact-Flash/General (from V9) ]]. The CF card's content can be examined using the ''Browse CF Content'' link on the same page.

=== Using Syslog ===
Many failures are listed in the ''Alarms'' and ''Events'' sections, as discussed above. However, some are not. It is a good habit therefore to take transcript of the systems log messages and browse through them in search of intermittent problems. This can easily be done by storing the syslog on the local CF card (as defined on [[ Reference8:Configuration/General/Logging | Configuration/General/Logging ]]). It is important to tick the check marks on [[ Reference8:Administration/Diagnostics/Logging | Administration/Diagnostics/Logging ]] in a sensible way in order not to flood the log with useless messages. As a starter, the following settings are recommended:

{|
| Category || recommended setting
|-
| TCP || off ||
|-
| PPP || off ||
|-
| PBX Calls || on ||
|-
| Gateway Calls || on ||
|-
| Gateway Routing || off ||
|-
| H.323 Registrations || on ||
|-
| SIP/UDP Registrations || off, unless you use SIP endpoints ||
|-
| SIP/TCP Registrations || off, unless you use SIP endpoints ||
|-
| SIP/TLS Registrations || off, unless you use SIP endpoints ||
|-
| H.323-NAT || off ||
|-
| Administration || off ||
|-
| TELx/PRIx/PPP || off, unless you use this interface ||
|-
|}
Please note that ''Administration'' might be a recommended setting if documentation of changes is an issue to you.

=== Resource sensitive PBX Configuration ===
Very often, resource issues are caused by inappropriate PBX configuration. Although there are of course a huge number of possibilities to do it wrong, here are a few prominent and easy to avoid things to keep in mind:

* do not use long identifiers. All PBX identifiers (user names, group names, ...) are stored in clear text in the PBX LDAP directory. Longer names use more flash space thus. If you deal with a 100 user PBX, you probably don't care. However, if you have 10.000 users structured in groups with a huge amount of members per group, calling a group <code>cti</code> instead of <code>Users with CTI Integration</code> does make a difference!
* do not put objects in to groups they do not need to belong to. You may be tempted to add users to certain groups ''by default'', thinking that it will make your life easier later on if the group assignment is in fact needed. However, group assignments not only consume flash space in the PBX's LDAP directory, but also consume in-core memory during run-time. Even more, doing so will make it more probably to exceed the maximum size of a single group (which is 2000 members currently). Having more than the allowed maximum of group members in a single group will result in strange behaviour which is difficult to track down.
* do not put objects as ''active'' members in to groups when they don't need to be active. ''Active'' group memberships consume additional DRAM memory as well as additional CPU cycles during run-time.
* do not configure [[Reference7:Administration/PBX/Objects#Object_Properties | group indications ]] when they are not needed. Group indications will result in additional memory and CPU consumption as well as network traffic. When group indications are configured, information is distributed to the respective group members regardless of if it is used there or not. So if no group indication is required, don't send it! If it is required, use the smallest group available to send them to. Do not re-use a group for this purpose just because it exists if it includes more members than required for the group indications. Rather create a new group and restrict it to the members required. One particular bad habit is to put all users in a single group, have them all be ''active'' and configure this group as the group used for ''group indications'' for all users. While this has the beauty that PBX functions which require group indications will always work (which to configure correctly may be a bit tedious sometimes), but it has the downside that each call to any of these users suffers from increased CPU and network load with each added user!
* do not create objects that aren't needed. Each PBX object consumes flash and DRAM memory, even if it is never used.
* do not put objects in to the group used by the TAPI service provider which are never monitored anyway. All activity information for all users in the tapi group is conveyed by the PBX to the TAPI service provider. If it is never used, this is a waste of resources and adds load both to the PBX and to the machine running the TSP.

=== Monitoring a multi-Device System ===
If your system consists of more than one relevant device, you may want to configure Alarm, Event and Syslog forwarding (as configured in [[ Reference8:Configuration/General/Logging | Configuration/General/Logging ]]) so you have this information in a single place to review.

==Related Articles==
[[Howto:Maximum_number_of_aliases_on_a_GW_interface|Howto:Maximum_number_of_aliases_on_a_GW_interface]]

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

Reference10:Concept Linux Application Platform

2017-01-02T09:54:20Z

Tle: /* Linux Application Platform (IPxx10 or IPx11 Gateways) */

==Introduction==

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

==Requirements==

There are 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 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

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

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

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

==Installation==

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

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

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


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


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

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

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

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

====VMWare====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Administration==

===General===

====Configure IP====

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

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

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

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

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

====Configure Authenticated URLs====

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

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

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

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

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

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

===Web Server===

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

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

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

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

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

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

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

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

Here you can change the credentials for Web Server access.

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

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

Here you can change the credentials for webdav access.

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

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

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

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

====Configure mutual TLS====

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

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

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

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

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

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

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

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

[[Image:backup_restore.jpg]]

====Command File====

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

The available default commands are:

=====saveinnovaphonecfgs=====

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

=====saveinnovaphonelogs=====

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

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

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

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

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

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

You can use some macros for the backup filename:

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

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

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

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

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

Open this link to restore all available files/data.

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

===Relay Hosts===

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

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

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

===Database===

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

====Password====

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

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

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

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

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

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

===Upload/Update===

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

==Diagnostics==

===Logs===

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

===RPCAP===

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

===Alarm Server===

Configure an innovaphone device as alarm server:

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

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

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

===Status===

View the disk usage.

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

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

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
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

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

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

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

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

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

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

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

Default trace level are "0"

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

===Tools===

====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%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

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

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

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

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

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

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

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

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

The same can be done for application specific passwords, e.g. Reporting.
In this case, use the file '''/home/lighttpd/innovaphone-reporting-htdigest.user'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

===Howto save and restore Linux AP data/database if the webgui is not available===

If the linux ap webgui is not reachable a common reason is that the harddisc is full.
If a full hd is the case, maybe your first thought is to increase the harddisc.
It could be a solution but there are some traps to increase the partition in linux which can be ended in complete data loss

The fastest way to get linux ap working with a new harddsik size is to install a new one.

'''How can you save the data without get access over the webgui?'''
If you can reach linux via putty it could be possible :)

Here are some possibilities how to do that over the shell:
'''(But keep in the back of you head that you are working as root and therefore typing errors can lead to undesirable behaviours!)'''

1. Delete at first all the logfiles. Sometimes a few MByte are enough to get all the stopped services running again and you could reach liunx over the webgui.
i.e. the reporting logfiles are under "''/var/www/innovaphone/apps/innovaphone-reporting/log''", the fax server logfiles are under
"''/var/www/innovaphone/apps/innovaphone-faxserver/log''"
-> '''Don't delete the 'log' directory itself!''' Delete only the content:

root@vmware-debian: cd /var/www/innovaphone/apps/innovaphone-reporting/log/
root@vmware-debian: rm *

Is the linux ap after a restart running and over http reachable, download all the config and databases and restore them on the new linux ap (2.2).

[[image:save.png]]

2. In case the reason for the unreachable webgui was not a full harddisk you can save the config/database (only reporting and exchange connector at the moment)
over the shell.

root@vmware-debian:/# cd /home/postgres/
''for reporting type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-reporting | gzip -fc6 > innovaphone-reporting-db.gz

root@vmware-debian:/# cd /home/postgres/
''for exchange connector type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-exchange | gzip -fc6 > innovaphone-exchange-db.gz

2.1 Access linux with winscp '''(protocol: scp / user: root)''' and download the .gz (don't unzip)

[[image:reporting.png]]

(BTW: you can '''download''' with '''scp''' also the complete webdav files. But for the '''upload''' use as user 'admin' and as protocol "'''webdav'''".
Otherwise the owner is still root and this ends in authorization problems)

[[image:webdav.png]]

2.2. on the new linux ap upload this .gz

[[image:restore.png]]

3. The steps mentoined above should be only the last try to get the data and could work or not.
To be always on the save site use a standby linux (for reporting), save configs (update server) and delete (automatic) old cdr's to avoid a full hd.

[[Category:Concept|Linux Application Platform]]

Reference10:Concept Exchange Calendar Connector

2016-11-23T15:31:32Z

Tle: /* Wireshark trace without SSL */

==Usage==

You can use the innovaphone Exchange Calendar Connector application to set the presence of a PBX user according to the Outlook calendar of the user. 
If the user has e.g. a meeting, the presence will be set to '''busy''' and the presence note to the subject of the calendar item (see [[ #Presence_Note_and_Activity | Presence Note and Activity]]).

==Requirements==

===innovaphone PBX===
The PBX must be V10 or higher.

===innovaphone Linux Application Platform===

It is needed to have the [[Reference9:Concept_Linux_Application_Platform|application platform]] installed and running with Hotfix13. {{FIXME|reason=required hotfix will change on release}}

===Microsoft Exchange Server===

The innovaphone Exchange Calendar Connector application supports the Microsoft Exchange Server 2010 SP1, SP2 and SP3, 2013 and Office 365!

====Enabled Windows Authentication====

As we use '''NTLM''' for authentication towards the Exchange Server, you'll have to enable the Windows Authentication in your IIS of the Exchange Server on the folder '''EWS''': http://technet.microsoft.com/en-us/library/cc754628%28v=ws.10%29.aspx 
If you right click on the Windows Authentication entry, you can select "Providers". Make sure, that the NTLM provider is active here! 
The Anonymous Authentication must be also active, just for the '''IUSR''', not everybody!

==== Basic Authentication ====
The Exchange Calendar Connector now also support Basic authentication since v10 sr11. If you disable HTTPS (just needed for debugging) towards the Exchange server, your password will be insecure!

This feature was introduced to support Office 365 since it uses Basic authentication and doesn't support NTML Authentication.

If your Exchange Server supports Basic authentication, you may have to add your domain to your configured user name, like '''domain\user'''.

==== Office 365 ====

It's possible to configure innovaphone Exchange Connector with Office 365 solution more information at: [[Howto:Microsoft_Office_365_Recommended_Product_Testreport | Office 365 Testreport]]

===Outlook / Permissions===

Each Outlook user has to grant read access to the calendar user, which is configured under [[#Exchange | Exchange]] in the '''Account''' property. 
 
Open the Outlook options, go to Calendar in the left menu and open the "Free/... options" (Frei/Gebucht-Optionen in german).
There you have to add new permissions for the calendar user. You can select the predefined selection '''Reviewer''' (Prüfer):
* no writing rights
* read '''Full Details''' (needed to establish a subscription, otherwise it won't work!)
* no delete items permission
* '''Folder visible''' under Other

Alternative setup will be add the user, which is configured under [[#Exchange | Exchange]] in the '''Account''' property, to a Group in AD and also include all other users/members that wish to share their calender to this group then you do the step described before but you add the "Group" to each user/member in outlook instead of the calender user used in the "Account" property.

It is also possible to grant permissions using Exchange Management Shell (grant permissions to to User ''innoconnector'' rights to see calendar of User ''user.alias''):

Add-MailboxFolderPermission -Identity user.alias:\calendar -User innoconnector -Accessrights Reviewer
http://technet.microsoft.com/en-en/library/dd298062%28v=exchg.140%29.aspx

You may have to localise the name of the calendar folder, e.g. calendar -> Kalender (german)

'''Note:'''
A possible alternative to configure settings above via the Outlook Client is to use PowerShell Scripts. Here is an [http://social.technet.microsoft.com/Forums/en-US/7fc1edfe-0a80-4bf2-b6f8-9875fd0d4017/add-calendar-shares-to-all-office-365-user-subscriptions?forum=winserverpowershell solution example].
This was not tested by innovaphone. If this is not OK or doesn't work for you, then you should configured like recommended above using the Outlook Client.

===Email Addresses===
The Exchange Calendar Connector needs the SMTP address of an exchange user. Therefor the '''E-Mail''' field of a PBX user object is used and each email address is tried to be resolved to the SMTP address. 
If your system name of your PBX has the '''Use as domain''' option checked, the '''h323''' name is also tried with '''h323@systemname''' and this is also done with further configured aliases of the '''E-Mail''' field, which have no domain.

So you may have the following Exchange User with multiple email addresses:
* test@innovaphone.com
* test@innovaphone.de
* Test.Tester@innovaphone.com (primary SMTP address)

The PBX (system name '''innovaphone.com''' with '''Use as domain''') user object:
* h323 '''test''' (used with system name -> '''test@innovaphone.com''')
* E-Mail '''test@innovaphone.de''' (this would also work without '''Use as domain''')
* E-Mail '''Test.Tester''' (used with system name -> '''Test.Tester@innovaphone.com''')

All three possibilities are successfully resolved, as each email address exists for an Exchange User.

A user object with no H323 name will be always ignored!

==Installation==

Download the latest version of innovaphone Exchange Calendar Connector.

Log into the application platform, go to the Applications tag, click on [[ Reference9:Concept_Linux_Application_Platform#Upload.2FUpdate|Upload/Update]] and upload the downloaded file.
The installation will start automatically and the page will refresh every two seconds showing the installation process.
If there is no error during the installation you will see at the end "Installation was succesfull". Otherwise,
you will get "installation failed" and the reason why it went wrong.

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

==Configuration==
===Device===

See [[ #Email_Addresses | Email Addresses]].

===Servers===
You can configure multiple PBX/Exchange pairs on one Linux Application Platform. 
There are three steps to configure on server:

====Server====
[[Image:exchange_server.jpg]]

* '''Name''': a name for a PBX/Exchange pair, which you can choose yourself
* '''Description''': a description
* '''Calendar Note Language''': strings like '''Away''' and '''Free until''' are translated into this language
* '''Presence Update Interval''': the interval, in which the calender presence will be updated inside the pbx and PBX user objects are tracked
* '''Trace''': enable/disable tracing

====PBX====

[[Image:exchange_pbx.jpg]]

* '''IP Address''': the IP address of your PBX
* '''Port''': the HTTP(s) port of your PBX
* '''Account''': the account, which reads the users from the PBX via SOAP, must have at least the right "Viewer"
* '''Password''': password for the account
* '''Dyn-PBX-ID''': for a Dynamic PBX
* '''HTTPS''': use HTTPS for the communication with the PBX
* '''Domain Filter''': Optionally enter a comma separated list of domains. PBX users without a matching email address are ignored.

====Exchange====

[[Image:exchange_ews.png]]

* '''Server''': the IP address or DNS name of your Microsoft Exchange Server
* '''Account''': the exchange user account, which has '''sufficiant access''' to the user calendars, which shall be monitored (see [[#Outlook|Outlook]] for how to grant these permissions). The account also needs to have a mailbox configured inside the Exchange server.
* '''Password''': the password of the user
* '''Omit Subject''': Omits the subject of a calendar entry from the presence note (presence status itself will be transmitted). Moreover, presentation of any presence on phone upon alert can be activated generally - see [[Reference10:PBX/Config/General#Common | PBX Config General : Presence with Alert]]
* '''Omit Date and Time in presence note''': Omits the date and time inside the presence note.

* '''Status Frequency''' (minutes): the subscriptions of user calendars are kept alive by dummy events, which are sent by the Exchange Server in this frequency
* '''Availability Timespan''' (hours): the timespan for which calendar items are retrieved
* '''Email(s)''': See [[ #Tentative_calendar_items | Tentative calendar items]]
* '''Exchange Version''': SP1 or SP2 of the Microsoft Exchange Server 2010 or Microsoft Exchange Server 2013. For Microsoft Exchange Server 2010 SP3 please use the setting 2010 SP2.
* '''Use HTTPS''': If set, the Exchange Server uses HTTPS to communicate with the Linux AP (HTTP connections from Exchange Server to Linux AP, ie: updates for calender entries)
** see [[#Use HTTPs for Exchange Notifications]]
* '''Linux DNS Name (optional)''': You can optionally set the DNS name of your Linux AP, which will be used by the Exchange server for HTTP requests.
* '''Linux NAT IP''':
* '''Linux NAT Port''': If your Linux AP is behind a NAT router in the view of your Exchange server, you have to configure a reachable Linux IP/Linux Port. This IP address has to be reachable from inside your Exchange server!

=====Connection Test=====
The connection test just tests the SOAP connection towards the Exchange Server. The SOAP connection from the Exchange Server to the Linux AP is not tested!

===Database===

The exchange application creates the innovaphone-exchange database to store users from the PBX.
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

The exchange application creates the database user '''innovaphone-exchange''' with default password '''exchange'''.
This password may be changed at the innovaphone Exchange Calendar Connector page under Config/Database.

====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 under Config/Database at the innovaphone Exchange Calendar Connector page.

==Diagnostics==
===Logs===
Download/View logs of the innovaphone Exchange Calendar Connector application.

===Exchange Database===
Select either '''All Servers''' or a specific server to list users or calendar items.

====List users====
List all monitored users and their current subscription state.

====List calendar items====
List all retrieved calendar items.

Note about "PBX Status" values:

Status 0: unsignaled towards PBX
Status 1: signaled with note but without activity (Free until...)
Status 2: signaled with note and activity (Busy until)
Status 3: note and activity removed

==Backup and Restore==

You can both manually and automatically backup the database and configuration files for the exchange application under [[Reference9:Concept_Linux_Application_Platform#Backup|Administration/Backup]] in the application platform.

Configuration details for the update server can be found [[Reference9:Concept_Linux_Application_Platform#Backup|here]].

===Configuration Files===

'''saveinnovaphone-exchangecfgs''' is the command used to automatically save configuration files with the [[Reference9:Concept_Linux_Application_Platform#Command_File|Command File]].

===Data===

'''saveinnovaphone-exchangedb''' is the command to automatically backup the whole innovaphone Exchange Calendar Connector database with the [[Reference9:Concept_Linux_Application_Platform#Command_File|Command File]].

As the database contains your server configuration, a backup might be usefull!

===Logs===

'''saveinnovaphone-exchangelogs''' to save log files with the [[Reference9:Concept_Linux_Application_Platform#Command_File|Command File]].

==Appendix==

===How it works===

For each server the following steps are done after the configured interval (some steps only once):
* All users from the PBX are retrieved via SOAP
* The primary SMTP address inside the Microsoft Exchange Server is retrieved for all users with a '''valid''' h323 name or E-Mail field
* A subscription for calendar events is established toward the Microsoft Exchange Server for all users with a primary SMTP address via SOAP [[ Reference9:Concept_Exchange#Microsoft_Exchange_Web_Services | EWS ]] with the configured user who has read access to the calendars of the other users
* The calendar items for the next e.g. 36 hours are retrieved for each new user (this step is only done once or if a new calendar event is received with the established subscription)
* The presence is set according to the calendar items of a user
* The established subscriptions monitor all changes inside the users calendars
* After the configured interval, the PBX users are compared to the already existing ones and if needed added/removed/renamed etc.

The first time after you have successfully configured the PBX and the Exchange Server, all user subscriptions are established and all calendar items are retrieved.
This may take some minutes, according to the user count.

===Presence Note and Activity===

The settings of a calendar item determine the presence activity and note. 
A calendar item is ignored, if its '''busy type''' is '''free''' or '''tentative''' (see [[ #Tentative_calendar_items | Tentative calendar items]]). 
The subject of a calendar item is ignored, if the calendar item is '''private'''.

The activity is only set, if the calendar item has already started!
Otherwise just the note is set. If just the note is set, the merged presence, received by the PBX,
will prefer presences with an activity. If there is no presence with an activity, the note is shown e.g. on the phone/in myPBX.

An all-day calendar item is e.g. from 25/05/2013 00:00 until 26/05/2013 00:00 and it's also displayed.

====Tentative calendar items====

A tentative calendar item is neither free nor away, so it is ignored by default. 
But if the organizer of a calendar item is one of the configurable email addresses, the item is treated as away!

====Activity====
The activity is set accordingly to the busy type of a calendar item:

{| border=1
|| '''Calendar Item Busy Type''' || '''Presence Activity'''
|-
|| Free || ''ignored''
|-
|| Tentative || ''ignored'' or Away
|-
|| Busy || Busy
|-
|| Out of office || Away
|-
|| Working Elsewhere || Away
|-
|}

====Note====
''The note of a not yet started calendar item contains the following parts:''

* the string '''Free until'''
* the date if the start date of the calendar item is not today
* the start time (Hours:Minutes) (if Hours:Minutes is '00:00' and the decreased date is not today, the time is cut and the date decreased by one day instead)
* the string '''Away''' if the activity is ''away''
* the subject of the calendar item or if the calendar item is private, the string '''Private'''

e.g.
Free until 28.07.2012 12:20 (Away: Vacation)
Free until 28.07.2012 12:20 (Meeting with boss)
Free until 12:20 (Away: Meeting with customer)
Free until 12:20 (Away: Private)

''The note of an already started calendar item:''

* the subject of the calendar item or if the calendar item is private, the string '''Private'''
* the string '''until'''
* the date if the end date of the calendar item is not today
* the end time (Hours:Minutes) (if Hours:Minutes is '00:00' and the decreased date is not today, the time is cut and the date decreased by one day instead)

e.g.
Vacation until 23.12.2012
Meeting until 23.12.2012 12:45

===Microsoft Exchange Web Services===
For communication with the Microsoft Exchange Server, its [http://msdn.microsoft.com/en-us/library/exchange/bb204119%28v=exchg.140%29.aspx Exchange Web Services] are used.

===Installed Debian Packages===

The following packages (and their dependencies) are installed with the innovaphone Exchange Calendar Connector:

* php5-mcrypt

===Configuration Files===

* pg_hba.conf is the client authentication configuration file and controls which hosts are allowed to connect, how clients are authenticated, which PostgreSQL user names they can use and which databases they can access.
* postgresql.conf is the PostgreSQL configuration file
* exchange.conf contains one configuration option

===Data Files===

If you backup the innovaphone Exchange Calendar Connector database, you'll get a gz archiv, which contains the whole innovaphone-exchange database.

===Database Structure===

====servers====

The configured servers.

====users====

Users retrieved from the configured PBX.

====calendar_items====

Calendar items for the users retrieved from the Microsoft Exchange Server.

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

====PGAdmin====

[http://www.pgadmin.org/ PGAdmin] is an administration tool for PostgreSQL databases.

====Putty====

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

==Known Issues==

===Use HTTPs for Exchange Notifications===
If you have to use HTTPs for Exchange Notifications, your Linux AP needs to have a '''signed''' certificate which contains the '''IP address''' of your Linux AP! 
You also have to trust the root certificate of your signed certificate on your Exchange Server.

* certificate of your Linux AP '''must''' contain its IP address
* a signed certificate must be trusted by ensuring that the root certificate is inside the certificate store "trusted root certification authorities"

Pay attention if you have set the '''Force HTTPs''' flag on your Linux AP! In this case requests of the Exchange Server are redirected to a HTTPs location and your Linux AP must meet the conditions from above!

===A user doesn't get calendar updates after configuration changes===
The Exchange Calendar Connector establishes a subscription for every user with the exchange server. If such a subscription request fails (e.g. calendar permissions are wrong/not set), the next retry is not done until '''2 hours''' later. This has been implemented to reduce the system load for systems with many PBX users, where such a fail is expected. 
 
If an administrator now tries to correct user settings, it might last up to 2 hours until the changes take effect. 
An administrator can still click through the Exchange Calendar Connector configuration to enforce new subscriptions for every user (but this may take much time for the first run).

==Trouble shooting==
===Wireshark trace without SSL===

You'll have to temporarily deactivate SSL in your Microsoft Exchange IIS server:
[[Image:Exchange_iis.jpg]]

Then activate RPCAP on your Linux Application Platform under Diagnostics->RPCAP. Start a Wireshark-Trace for your Linux IP on both interfaces LO and ETHO. 
 
Walk through your Exchange Connector configuration, add ''':80''' to your ip address or dns name of your Exchange Server, e.g. '''172.16.17.18:80''' and commit the changes.
 
Save the wireshark trace after about 10 minutes.

Keep in mind, that with Basic authentication (used with Office 365), your password will be transferred in plain text if you disable SSL!

===Howto save and restore Linux AP data/database if the webgui is not available===
See [[Reference10:Concept_Linux_Application_Platform#Howto_save_and_restore_Linux_AP_data.2Fdatabase_if_the_webgui_is_not_available|Troubleshooting Linux AP]]

[[Category:Concept|Exchange Calendar Connector]]

Reference10:Concept Reporting

2016-11-23T15:30:25Z

Tle:

==Requirements==

It is needed to have the [[Reference10:Concept_Linux_Application_Platform|application platform]] installed and running.

===Calculation of required disk space===

An average CDR requires 2080 bytes of disk space inside the database. 
So '''one GB''' disk space is needed for ~'''516222 CDRs'''. 
One call may have one or multiple CDRs depending on the call flow, the used PBX objects and their configuration.


It is strongly recommended that you try to precalculate your required disk space and configure a suiting value under [[#Configure_scheduled_CDR_cleanup]]. 
Don't forget to configure the alarm server under [[Reference10:Concept_Linux_Application_Platform#Alarm_Server]] to receive an alarm if the disk is nearly full (10% disk space remaining).


==Installation==

Download the latest version of innovaphone reporting.

Log into the application platform, go to the Applications tag, click on [[ Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|Upload/Update]] and upload the downloaded file.
The installation will start automatically and the page will refresh every two seconds showing the installation process.
If there is no error during the installation you will see at the end "Installation was succesfull". Otherwise,
you will get "installation failed" and the reason why it went wrong.

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

==Configuration==
===Device===

====License====
It is required to have a Reporting license installed on your device. Check under [[ Reference10:General/License ]] if you already have one.

Set the Reporting flag for each PBX object, which should be reported on the objects properties page.

====CDR Gateway====
Any innovaphone device which sends [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDRs]] to the reporting application must have at least one CDR interface configured under [[ Reference10:Gateway/CDR ]]:

* Type: LOCAL-AP or REMOTE-AP/REMOTE-AP-S

If HTTP/HTTPS is selected then some other parameters must be set:

* Address: ip address of the application platform
* Port: 80 for REMOTE-AP
* Port: 443 for REMOTE-AP-S
* Method: POST/GET
* Path: ap/cdr.fcgi

The application platform is by default password protected, so you'll have to perform one of these steps: 

* configure an authenticated URL for '''ap/cdr.fcgi''' under [[ Reference10:Services/HTTP/Client ]] (recommended)
** If you configure an authenticated URL (with the linux webserver credentials), 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
* configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]]

Configure a second CDR interface, if you use [[#Replication|Replication]].

====Enable PBX CDRs====
Enable the "Generate CDRs" flag under [[ Reference10:PBX/Config/General ]].

===innovaphone Application Platform===

If the reporting URL/user/password is not configured in your device as authenticated URL, configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]].

===Database===

Reporting creates the innovaphone-reporting database to store CDRs sent from any innovaphone devices (appendix 7.6 explains the database structure).
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

Reporting creates the database user '''innovaphone-reporting''' with default password '''reporting'''.
This password may be changed at the innovaphone Reporting page under Config/Database.

====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 under Config/Database at the innovaphone reporting page.

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

====Delete CDRs====

You can delete CDRs for certain/all users in a certain timespan. If you enter '''%''' as object, all users are selected.

Note that PostgreSQL doesn't free the space on the disk! If you need free disk space, issue this command on the shell:
''sudo -u postgres vacuumdb -f innovaphone-reporting''
This may take some time and CDRs won't be received during this time.

====Configure scheduled CDR cleanup====

If you activate scheduled cleanup, CDRs older than the configured amount of months will be automatically deleted. 
The scheduled task is started once a day at 2 AM.

===PBX===

If you use multiple PBX devices which are not Master/Slave, you have to select, which identifier is unique for a user under Config/PBX:
* System Name (default)
* PBX Name

The selected value determines, which values are shown in the PBX dropdown box for report creation or report mail configuration.

===Replication===

You can configure a second innovaphone application platform with an installed innovaphone Reporting for replication purposes. 

* Mode:
** '''Off''': no replication
** '''Master''': the local server is the master server
** '''Standby''': the local server is the standby server, filters will be replicated from the master and can't be changed here
* Master/Standby Server: the IP address of the master or standby server
* Database password: the PostgreSQL database password of the other server (default is '''reporting''').
* Synchronisation interval: the interval in minutes (range 1-60) in which a sync is done

Now configure a second [[#CDR_Gateway|CDR Gateway]] for the standby server.

The current status can be seen here too. If the status is '''Failed''' take a look at the log file '''innovaphone Reporting Replication''' under [[ Reference10:Concept_Linux_Application_Platform#Logs|Diagnostics/Logs]] or look at the last trace output at the bottom of the page.
 
 
How replication works is described [[#Replication_2|here]].

===Ldap===

Several LDAP servers and dialing locations can be configured here. 

PBX field must correspond to a name of a PBX since PBX's names are available in CDRs. The received CDR is parsed to get the PBX name and this name will be used to find the corresponding LDAP server and dialing location needed to resolve names.

Each configured LDAP server and dialing location can be activated/deactivated with the '''active''' flag.

[[Image:ldap_update.png]]

If the country where you configure LDAP does not have Trunk/National prefix you should leave "National Prefix" and "Area Code" empty.

In the number Attributes field please do '''not''' add any additional characters to the attributes like ":P", ":D" or "@", for instance "homePhone:P, mobile:M, telephoneNumber:D". This does not work. That would be correct: "homePhone, mobile, telephoneNumber"

LDAP Internal Search flag allows reporting to perform name resolution also for internal numbers.

Search Base H323 checkbox means that h323 field of the CDR user will be used inside the LDAP Filter to resolve the telephone number.

===Report Mails===

Automatic report generation can be configured here:

* '''time''': daytime at which the report is sent
* '''user reports''':
** Creates for each matching user a separate report
** Users are matched by '''Object (Long Name)'''
** A user report only contains calls for this user
** The email address of the user is built by its '''H323 name''' and the '''System Name''' of its PBX (h323@systemname) or determined by the E-Mail field of the user
* '''interval''':
** daily: Mail will be send daily with the automatic period "last day"
** weekly: Mail will be send weekly with the automatic period "last week"
** monthly: Mail will be send daily with the automatic period "last month"
* '''day''': the day, at which the report is sent
* '''mail adresses''': recipients of the report (comma separated)
* '''Sender E-Mail address''': sender email address, which may be present as [[ Reference10:Concept_Linux_Application_Platform#Relay_Hosts | relay host ]]
* '''compress''': compress the attachment or not
* '''sort by'''
* '''sort order'''
* '''language'''
* '''send time''': the time of a day, when the report is sent

The explanation for the other settings can be found [[ #Report_Creation | here. ]] 

[[Image:mails.png]]

===Users===

You can configure multiple users, who shall have access to reports without having access to the whole reporting configuration. 
The user can login with his user name and password on: 

http(s)://Linux-IP/apps/innovaphone-reporting/user/login.php

The admin can assign one or more base filters to the user. A base filter is explained [[ #Base_filter | here]]. 
If the user creates new reports, new own filters or report mails, he '''has''' to use one of his assigned base filters.

If you are using multiple PBX systems, the user has only access to these systems, which are configured in the base filters of the user.
If the user has no base filter with a limitation to a certain "System Name"/"PBX Name" (depends on your [[ #PBX | PBX configuration ]]),
he will have access to all systems!

[[Image:users.jpg]]

====User Login====

A logged in user can create reports, own filters and report mails based on his assigned base filters.

[[Image:Userlogin.jpg]]

===Images===

You may upload images to be used as logo or footer in pdf reports. 

Logos must be 32x32 and footer can have a maximum width of 450 pixels and a maximum height of 50 pixels. 

These images can have jpeg or png format. 

===Relay CDRs===

Relay CDRs can be stored in log files by the Reporting application. Configure a CDR gateway as already described and relay CDRs will be written to the webdav file '''/cdr/cdr.txt'''.
The file is rotated on 1 MB size. The first rotated file is uncompressed, further files will be gz compressed. Max ten files are kept. Older files will be deleted: 
* cdr.txt
* cdr.txt.1
* cdr.txt.2.gz
* cdr.txt.3.gz
* cdr.txt.4.gz
* cdr.txt.5.gz
* cdr.txt.6.gz
* cdr.txt.7.gz
* cdr.txt.8.gz
* cdr.txt.9.gz

===innovaphone-reporting web access===

You can configure a separate authentication for the innovaphone-reporting web site [[Reference10:Concept_Linux_Application_Platform#Change_application_access_credentials|here]]. 
One can just login on the reporting site with this access.

===Integration Voice recorder===

The innovaphone voice recording can be integrated and a remote control of the player is possible, see relative article.

==Filters==
===General===

Filters are set up to create reports based on certain conditions. A filter can have multiple conditions and multiple filters can be combined on report creation (combine is performed with an '''OR'''). 
A filter has a unique '''name''' with an optional '''description'''.

===Conditions===

[[Image:filter.png]]

There are five or seven condition sections depending on what is selected under '''States'''. Conditions inside same section are '''OR''' associated while different sections are '''AND''' associated.
 

(Object == Terra '''OR''' Object == Uranus) '''AND''' (PBX == sifi) '''AND''' (Number == 0049%)

====Base filter====

If you select another filter as base filter, the conditions of the base filter are implicitly '''AND''' conjuncted, when the current filter is used. 
So if the base filter defines two PBX values, e.g. "Berlin" and "Hamburg" and the current filter defines one PBX value, e.g. "Berlin", only objects of the PBX "Berlin" will be filtered: 

(pbx="Berlin") AND (pbx="Berlin" OR pbx="Hamburg")

If a user defines an own filter for his reports, he has to use a base filter, which he is allowed to use. So each filter, which he uses, will have at least one base filter condition, which the admin has defined.

You have to take care with the conditions of the current filter and the base filter,
as it is now easy to create a filter with mutually exclusive conditions, e.g. if
the filter has pbx="Berlin" and the base filter pbx="Hamburg" => no matching records.

====Anonym====

If you check this flag, a report created with this filter or with a filter, where this filter is a basefilter, will by anonymized.

====Local====

Define one ore more conditions for the local party, defined by:

* Object: the cn/PBX object name
* Number: the number
* Groups: a group of the PBX object

====Remote====

Define one or more conditions for the remote party, defined by:

* Number: the number
* Remote display name: the display name

====PBX====

Define one ore more conditions for the PBX, defined by:

* PBX: the PBX name
* Node: the node name

====States====

* No Response
* Connected
* Busy
* No Channel

====Directions====

* Incoming
* Outgoing
* Transfer: calls, which have been transferred to the current local party
* Call Forward: calls, which have been forwarded to the current local party

====Call Duration====

Time the call was connected.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or No Response is unselected, then the filter will search for Connected calls with connected time greater or smaller than '''Call Duration'''.

====Alert Duration====

Time the call was ringing independent of the status of the call afterwards.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or Connected is unselected, then the filter will search only for Not Connected Calls that were ringing more or less time than '''Alert Duration'''.

====Report times====

Define the time where calls should be counted. 
You can optionally define the weekday(s) of calls.

====Images====

* Logo: This must be 32x32 pixel image in jpeg or png format. 
* Footer: Maximum width of 450 pels and maximum height of 50 pels. Also jpeg or png format. 

====Using Patterns====

You can use these [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]] for every condition.

==Report Creation==
===General===

It is possible to generate call lists for single users or more complex reports by means of filters.

===Web Interface===

Reporting application provides a web interface to generate reports.

[[Image:Report_hide.png]]

* '''PBX''': select the PBX for the report. The values of the drop down box depend on your [[#PBX | PBX configuration]]
* '''Object (Long Name)''': corresponds to the PBX Long Name assigned to a specific user (% is a special postgresql character, which matches any string)
* '''Filter''': one or multiple filters can be defined ('''OR''' joined)
* '''Group by''': the result can be grouped by Date or Object
* '''Hide last X digits''': you may replace the last digits of an external number with a '*'.
** LDAP must be configured in order to use this capability but if you want no LDAP funtionality, just unset the Active Box in LDAP.
** Actually, the pbx/phys value of a call is matched against the LDAP pbx value and if the number starts with the external line prefix.
* '''Anonym''': do not show internal names/numbers
** If anonym is set, hide last digits is set to 3, if not set
* '''Filter Info''': the report will contain information about the configured settings and filter information
* '''Displayed Duration''':
** Call Duration (Total): the total call duration, e.g. with the duration of a subsequent transfer
** Call Duration (User): just the time, the user was connected
** Billing Duration: the duration, a user must be billed for
** None of these durations contain the alert duration, which is separatly listed

[[Image:reporting_report.png | A normal report. The summary shows incoming / outgoing summaries]]

[[Image:grouped_report.png | A grouped report. Each group has an own summary]]

====Print====

Click the print icon to open a printable version of the report.

====Save====
You can save the report as '''pdf''' or as '''xml''' by using the corresponding icon. 
You can also download a report in '''csv''' format without call history. The report uses '''comma''' as delimeter character, '''"''' as text qualifier and '''PBX Object/Remote Party''' columns should be defined as Text (avoid telephone numbers to be considered as numbers by Excel). '''UTF-8''' must be used as character set. 

====Sorting====

Each sortable column has a clickable column head. This sorting will be also used when opening the printable version or saving the report as PDF.

====Icons====
The icons are explained in the [[#Call list icons|appendix]].

===Remote Interface===

See [[#Remote_Interface_2|Remote Interface Appendix]]

==Backup and Restore==

You can both manually and automatically backup the database and configuration files for Reporting under [[Reference10:Concept_Linux_Application_Platform#Backup|Administration/Backup]] in the application platform.

Configuration details for the update server can be found [[Reference10:Concept_Linux_Application_Platform#Backup|here]].

===Configuration Files===

'''saveinnovaphone-reportingcfgs''' is the command used to automatically save configuration files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

===Data===

'''saveinnovaphone-reportingdb''' is the command to automatically backup the whole innovaphone Reporting database with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

If you restore the reporting database, you should keep in mind, that this might take several hours for a system
on a CF card, depending on the size of the restored database. The backup process itself is quite fast with a few minutes.

===Logs===

'''saveinnovaphone-reportinglogs''' to save log files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

==Appendix==
===PostgreSQL Patterns===
For filter conditions or for the pbx object value you can use the following patterns inside a string:

* '''%''': matches any string of zero or more characters
* '''_''': matches any single character

Example:
'''Sat%''' will match all pbx objects, which start with the string '''Sat'''.

We do always perform case insensitiv searches!

===innovaphone Reporting XML===
<code type="xml">
<?xml version="1.0" encoding="utf-8"?>
<application>
<name>innovaphone Reporting</name>
<desc>Reporting software</desc>
<directory>innovaphone-reporting</directory>
<href>report.php</href>
<linux-username>innovaphone-reporting</linux-username>
<packages>
<package>php5-gd</package>
<package>php5-ldap</package>
</packages>
<database name="innovaphone-reporting" username="innovaphone-reporting"/>
<cronjobs>
<cronjob script="/etc/cron.d/reporting_replication"/>
<cronjob script="/etc/cron.d/reporting_cleanup"/>
<cronjob script="/etc/cron.d/reporting_mails"/>
</cronjobs>
<log-files>
<log title="Postgresql-8.4" no-clear="true">/var/log/postgresql/postgresql-8.4-main.log</log>
<log title="Reporting cleanup">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_cleanup.log</log>
<log title="innovaphone Reporting">/var/www/innovaphone/apps/innovaphone-reporting/log/innovaphone-reporting.log</log>
<log title="innovaphone Reporting Replication">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_replication.log</log>
</log-files>
<config-files>
<conf>/etc/postgresql/8.4/main/pg_hba.conf</conf>
<conf>/etc/postgresql/8.4/main/postgresql.conf</conf>
<conf>/home/innovaphone-reporting/reporting.conf</conf>
<conf>/home/root/ssl_cert/server.key</conf>
<conf>/home/root/ssl_cert/server.crt</conf>
<conf>/etc/cron.d/reporting_replication</conf>
<conf>/etc/cron.d/reporting_cleanup</conf>
<conf>/etc/cron.d/reporting_mails</conf>
<conf>/var/www/innovaphone/apps/innovaphone-reporting/report_images</conf>
</config-files>
<backup>
<command title="Save innovaphone Reporting configuration files" cmd="saveinnovaphone-reportingcfgs" script=""/>
<command title="Save innovaphone Reporting database" cmd="saveinnovaphone-reportingdb" script=""/>
<command title="Save innovaphone Reporting log files" cmd="saveinnovaphone-reportinglogs" script=""/>
</backup>
<restore>
<command title="Restore innovaphone Reporting configuration files" cmd="restoreinnovaphone-reportingcfgs" script="">
<action>/etc/init.d/postgresql restart</action>
<action>/etc/init.d/cron restart</action>
</command>
<command title="Restore innovaphone Reporting database" cmd="restoreinnovaphone-reportingdb" script=""/>
</restore>
<uninstall script="/usr/bin/sudo /usr/local/bin/uninstall_script.sh -f 'innovaphone-reporting.xml' -linux_user yes -linux_group yes -database yes -database_user yes -log_script '/var/www/innovaphone/log/appl_uninstall.log'">
<to-delete>
<to-del path="/usr/local/bin/reporting_cleanup.sh"/>
<to-del path="/usr/local/bin/reporting_replication.out"/>
<to-del path="/usr/local/bin/reporting_replication.sh"/>
<to-del path="/home/innovaphone-reporting/tmp"/>
</to-delete>
</uninstall>
<lighttpd-auth>1</lighttpd-auth>
<public-web-paths>
<path>mypbx</path>
<path>user</path>
</public-web-paths>
</code>

===Installed Debian Packages===

The following packages (and their dependencies) are installed with innovaphone Reporting:

* php5-gd
* php5-ldap

===Configuration Files===

pg_hba.conf is the client authentication configuration file and controls which hosts are allowed to connect, how clients
are authenticated, which PostgreSQL user names they can use and which databases they can access.

postgresql.conf is the PostgreSQL configuration file

===Data Files===

If you backup the innovaphone reporting database, you'll get a gz archiv, which contains the whole innovaphone-reporting database.

===Report XML and CSV===
The field description below applies for the '''XML''' and '''CSV''' columns!

<code type="xml">
<report>
<record>
....
<time time="1301303966" utc="1301303966">2011-03-28 11:19:26</time>
<obj>Saturn</obj>
<id>870998fee909d311b2ec009033105dc9</id>
<call>int</call>
<alert-duration seconds="0">0:00</alert-duration>
<flow>
<ev caller="ep1" ep1_number="101" ep1_name="saturn" ep1_dn="Saturn"
ep2_number="102" ep2_name="uranus" ep2_dn="Uranus" status="co" entry="true"/>
</flow>
<call-duration seconds="2">0:02</call-duration>
<billing-duration seconds="2">0:02</billing-duration>
<conn-duration seconds="2">0:02</conn-duration>
<groups>
<group>test</group>
<group>test2</group>
</groups>
<node>root</node>
<pbx>.</pbx>
<cause></cause>
<dir>o</dir>
<status>co</status>
<type/>
<remote number="102" name="uranus" dn="Uranus"/>
<callback number="456" name="abc" dn="123" time="1301305962">2011-03-28 11:52:42</callback>
</record>
....
</report>
</code>

* time: the node contains a formatted time string of the local time
** attribute '''time''' is a unix timestamp (referring to the local time stamp of the CDR)
** attribute '''utc''' is a unix timestamp (referring to the utc time stamp of the CDR)
* obj: the PBX object name (also called cn)
* id: the conference id of the call
* call: '''int''' (internal) or '''ext''' (external) call
* flow '''(XML only)''': the call flow
** ev
***ep1 (ep1_number, ep1_name, ep1_dn): the left side of the call
***ep2 (ep2_number, ep2_name, ep2_dn): the right side of the call
***caller: '''ep1''', '''ep2''' or empty, if unknown
***status: '''co''' (connected), '''al''' (alert), '''er''' (error) or '''bu''' (busy) state of the current event
***entry: '''true''' for the entry event of the local object
***type: '''cf''' (call forward), '''ct''' (call transfer)
* Original Called '''(CSV only)''': In case of Call flow; The original called device
* Diverting '''(CSV only)''': In case of Call flow; The diverting device
* Transferring '''(CSV only)''': In case of Call flow; The transferring device
* groups '''(XML only)''': the groups of the PBX object
* node: the node of the PBX object
* pbx: the pbx of the PBX object
* cause: the decimal disconnect reason of the call (see [[Reference:ISDN_Cause_Codes]])
* remote:
** outgoing calls -> dialed endpoint
** incoming calls -> first ep2 above entry event or entry event if this is the first one
** incoming calls with incoming transfer after entry event -> transfer target
* status:
** outgoing calls -> best found status in call flow
** incoming calls -> status of entry event
* type: the type of the entry event or, if not set, the type of the next event, if given
** empty: direct call
** '''ct''': call transfer
** '''cf''': call forward
** '''cct''': call transfer with consultation
** '''pu''': call pickup
* dir: o (outgoing) if the first event is the entry event and the caller is ep1
* dir: i (incoming) if not o
* alert-duration: alert time
*Billing Duration: the duration, a user must be billed for
** outgoing call -> duration from the first event until the last event in the flow
** incoming call -> duration from the first transfer/forward event until the last event in the flow
* call-duration/Call Duration (Total): duration of the whole call, e.g. with the duration of a subsequent transfer
* conn-duration/Call Duration (User): just the time, the user was connected. Duration from the entry event until the event, where the local endpoint isn't connected any more
* callback: '''name''', '''number''', '''dn''' and '''time''' if this call has been callbacked using mypbx (time referrs to the UTC time of the callback)
* Further Registration: If more than one devices is registered to the same object, each device creates a CDR. This field identifies the additional CDRs for the same call
* Object Info '''(CSV only)''': combination of object names and number
* Date '''(CSV only)''': extracted date only from the time_string
* Time_2 '''(CSV only)''': extracted time only from the time_string

===Database Structure===

====cdrs====
Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDR]])

This section is composed by four tables: cdrs, events, groups and cdr_properties.
The first three tables contain the corresponding fields to store the information contained in the cdr, event and group tags. 
Each CDR represents the call in the view of one PBX object. So there might be multiple CDRs for one call if multiple PBX objects are used within the call.

* '''cdr fields:''' id, guid, sys, pbx, node, device, cn, e164, h323, dir, utc, local.
* '''event fields:''' id, msg, type, e164, h323, conf, cause, time, cdr_id, order_index.
* '''group fields:''' id, name, active, type, cdr_id.

'''id''' field is assigned by postgresql for each entry and has nothing to do with the information present in the cdr. It is different for each entry inside the table.

The events table has two additional fields, called cdr_id, to associate these events to the corresponding cdr entry and order_index to keep their position inside the cdr.
Groups table has also the cdr_id field to associate the group entries to the corresponding cdr and events entries.

The '''cdr_properties''' table contains relevant information associated with the call such as call_length, alert_length or call_flow. It also presents a cdr_id field.

====filters====

This section is composed by three tables: filter_columns, filter_conditions and filters.

* '''filter_columns''' is not used for the time being. This is supposed to contain the columns the user wants to see in his report, but right now, just default columns (Time/Object/Duration/Left/Direction/State/Right) are shown.
* '''filter''' contains the filter name and description plus two conditions call_state (No Response, Connected, Busy and No Channel) and direction (Incoming, Outgoing, Transfer and Call Forward).
* '''filter_conditions''' contains the defined conditions for a filter

All three tables are related through an id.

====cdr_users====

This table contains a timestamp '''missed_calls_time''' for the last report access by a user '''cn''' + ('''pbx''' OR '''sys''') with mypbx. It is used to retrieve information about missed calls since the last use of mypbx. 
The timestamp '''clear_report_time''' indicates the last clearance time. 
email, sys (system name) and pbx (PBX name) are also stored for each user.

====replication====

Contains information of the last replication run, which is used to sync master/standby installations.

===Replication===

The replication between the master and standby servers is divided into two steps:

====CDRs====
Both master and standby server keep an information about the last replicated CDR. From this CDR on, they retrieve all CDR guids (32 bytes) from all new CDRs from the other server. If a guid already exists in the local database, the CDR is skipped, otherwise it is replicated. 
So there is a minimal data exchange for already existing CDRs and each new CDR is only processed once.

====Filters/LDAP/Report Mails/Users====
The master server does nothing here, but the '''standby''' deletes all filters, LDAP servers, report mails and users and replicates all from the master. 
So these items from the master server can be used, but not changed, on the standby server.

===Remote Interface===

You can retrieve the PDF/XML/CSV report with a remote interface. 
Make a POST or GET HTTP request to '''http(s)://Linux-IP/apps/innovaphone-reporting/report.php''' with the following parameters:

* remote: mandatory for a remote request!
** '''1'''
* from : the from date/time as UNIX timestamp '''OR''' date/time string as described [ http://www.php.net/manual/de/datetime.formats.php | here ].
* to: the to date/time (format see '''from''')
* [format]: the return format, allowed values:
** '''xml''': default
** '''pdf'''
** '''csv'''
* [sortby] : the report sorting, allowed values:
** '''time''': default
** '''obj''': sort by pbx object name
** '''call-duration'''
** '''alert-duration'''
** '''dir''': sort by call direction
* [sortorder]: the report sort order, allowed values:
** '''ascending''': default
** '''descending'''
* [groupby]: report grouping
** default empty/not set: no grouping
** '''local_stamp''': group by time
** '''cn''': group by pbx object name
* [hidedigits]: hide the last X digits of external numbers
* pbx: search for this PBX (mandatory!)
* pbxobject: search for this PBX object (you can leave this, if you use filterX)
* filterX: use a filter with its name. You can use multiple filters with filter1=test, filter2=test2...
* [filterinfo]: show the filter information in a created report ("true" or "false")
* [lang]: the language, e.g. "en" or "de"
* [displayedduration]:
** '''call_duration''': default Call Duration (Total)
** '''conn_duration''': Call Duration (User)
** '''billing_duration''': Billing Duration
* [anonym]: anonymize internal names/numbers ("true" or "false")
* [bulk]: creates user reports (see [[ #Report_Mails | Report Mails ]])
* [sender]: sender email adress of the report
* [confid]: query calls of a certain conference ID
** you can omit the following fields, if using confid: '''from''', '''to''', '''pbx''', '''pbxobject''', '''filterX'''

Parameters in [] are optional.

'''pbxobject''' supports [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]].

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&pbxobject=Saturn
Gets all records between 2011-03-29 and 2011-03-30 for the pbx object Saturn.

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&filter1=test&filter2=test2
Gets all records between 2011-03-29 and 2011-03-30 for the filters test and test2.

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

====PGAdmin====

[http://www.pgadmin.org/ PGAdmin] is an administration tool for PostgreSQL databases.

====Putty====

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

===Call list icons===
The direction of the icon arrow depends on the call flow.

* [[Image:reporting_conn.jpg]]: a connected call
* [[Image:reporting_busy.jpg]]: busy destination
* [[Image:reporting_no_res.jpg]]: no response from destination
* [[Image:reporting_error.jpg]]: an error occurred, like "no channel available" during the call setup
* [[Image:reporting_ct.jpg]]: call transfer
* [[Image:reporting_cct.jpg]]: call transfer with consultation
* [[Image:reporting_cf.jpg]]: call forward
* [[Image:Reporting_pickup.jpg]]: call pickup (or SOAP redirect)
* [[Image:reporting_dir.jpg]]: call direction

A small arrow on a call state icon indicates a callback done with mxPBY, e.g.:
* [[Image:reporting_busy_callback.jpg]]

==Known Problems==
===Replication===
====Callback information====
The callback information get lost in the following scenario:
* The callback CDR is already replicated on both master and standby
* Master or standby is down
* A user calls back the CDR from point 1

====Missed calls====
The information for missed calls is not replicated. So the first time, a standby server is used with mypbx, the missed calls information will be wrong. The second time will be correct again.

===CDRs===
If the innovaphone Reporting is not running, for whatever reaseon, the device, which sends CDRs, currently stores up to 300kB CDRs data. So if one CDR has up to 2kB, 150 CDRs can be stored until the innovaphone Reporting should be up again, to avoid data loss.

===Missing values for PBX drop down box===
If your database currently contains no CDRs of one of your PBX systems, you won't be able to select this system as PBX for report creation or report mail configuration!

===Restoring Database with more than 2GB===

When restoring database using the web browser there is a 2GB upload limit, so if our database have a bigger size the upload will fail.

As alternative solution (if there is enough space):

1. Copy the gz database dump to the webdav folder
2. Uncompress this dump: /bin/gzip -cd /var/www/innovaphone/webdav/dump.gz --uncompress > /tmp/db.dump
3. Start the restore: /usr/local/bin/config.sh postgres db-restore /tmp/pg_schema.dump /tmp/db.dump innovaphone-reporting
4. be patient, this might take a while
5. delete /tmp/db.dump, /var/www/innovaphone/webdav/dump.gz and /tmp/pg_schema.dump (automatically created)

===PDF generation for many CDRs may fail===
You may experience a '''Server error 500''' if you generate PDFs with many CDRs. The PDF library which is used to generate the PDFs fails.
Please generate multiple PDFs with a smaller timespan in such a case.

==Troubleshooting==

===Howto save and restore Linux AP data/database if the webgui is not available===
See [[Reference10:Concept_Linux_Application_Platform#Howto_save_and_restore_Linux_AP_data.2Fdatabase_if_the_webgui_is_not_available|Troubleshooting Linux AP]]

== Related Articles ==

[[Howto:Integration_reporting_and_voice_recording]]

[[Category:Concept|Reporting]]

Reference10:Concept Linux Application Platform

2016-11-23T15:23:46Z

Tle: /* TroubleShooting */

==Introduction==

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

==Requirements==

There are 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 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

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

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

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

==Installation==

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

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

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


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


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

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

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

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

====VMWare====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Administration==

===General===

====Configure IP====

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

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

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

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

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

====Configure Authenticated URLs====

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

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

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

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

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

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

===Web Server===

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

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

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

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

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

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

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

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

Here you can change the credentials for Web Server access.

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

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

Here you can change the credentials for webdav access.

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

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

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

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

====Configure mutual TLS====

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

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

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

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

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

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

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

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

[[Image:backup_restore.jpg]]

====Command File====

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

The available default commands are:

=====saveinnovaphonecfgs=====

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

=====saveinnovaphonelogs=====

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

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

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

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

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

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

You can use some macros for the backup filename:

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

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

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

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

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

Open this link to restore all available files/data.

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

===Relay Hosts===

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

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

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

===Database===

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

====Password====

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

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

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

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

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

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

===Upload/Update===

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

==Diagnostics==

===Logs===

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

===RPCAP===

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

===Alarm Server===

Configure an innovaphone device as alarm server:

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

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

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

===Status===

View the disk usage.

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

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

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
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

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

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

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

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

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

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

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

Default trace level are "0"

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

===Tools===

====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%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

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

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

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

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

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

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

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

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

===Howto save and restore Linux AP data/database if the webgui is not available===

If the linux ap webgui is not reachable a common reason is that the harddisc is full.
If a full hd is the case, maybe your first thought is to increase the harddisc.
It could be a solution but there are some traps to increase the partition in linux which can be ended in complete data loss

The fastest way to get linux ap working with a new harddsik size is to install a new one.

'''How can you save the data without get access over the webgui?'''
If you can reach linux via putty it could be possible :)

Here are some possibilities how to do that over the shell:
'''(But keep in the back of you head that you are working as root and therefore typing errors can lead to undesirable behaviours!)'''

1. Delete at first all the logfiles. Sometimes a few MByte are enough to get all the stopped services running again and you could reach liunx over the webgui.
i.e. the reporting logfiles are under "''/var/www/innovaphone/apps/innovaphone-reporting/log''", the fax server logfiles are under
"''/var/www/innovaphone/apps/innovaphone-faxserver/log''"
-> '''Don't delete the 'log' directory itself!''' Delete only the content:

root@vmware-debian: cd /var/www/innovaphone/apps/innovaphone-reporting/log/
root@vmware-debian: rm *

Is the linux ap after a restart running and over http reachable, download all the config and databases and restore them on the new linux ap (2.2).

[[image:save.png]]

2. In case the reason for the unreachable webgui was not a full harddisk you can save the config/database (only reporting and exchange connector at the moment)
over the shell.

root@vmware-debian:/# cd /home/postgres/
''for reporting type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-reporting | gzip -fc6 > innovaphone-reporting-db.gz

root@vmware-debian:/# cd /home/postgres/
''for exchange connector type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-exchange | gzip -fc6 > innovaphone-exchange-db.gz

2.1 Access linux with winscp '''(protocol: scp / user: root)''' and download the .gz (don't unzip)

[[image:reporting.png]]

(BTW: you can '''download''' with '''scp''' also the complete webdav files. But for the '''upload''' use as user 'admin' and as protocol "'''webdav'''".
Otherwise the owner is still root and this ends in authorization problems)

[[image:webdav.png]]

2.2. on the new linux ap upload this .gz

[[image:restore.png]]

3. The steps mentoined above should be only the last try to get the data and could work or not.
To be always on the save site use a standby linux (for reporting), save configs (update server) and delete (automatic) old cdr's to avoid a full hd.

[[Category:Concept|Linux Application Platform]]

Reference10:Concept Reporting

2016-11-23T15:22:17Z

Tle: /* Backup and Restore */

==Requirements==

It is needed to have the [[Reference10:Concept_Linux_Application_Platform|application platform]] installed and running.

===Calculation of required disk space===

An average CDR requires 2080 bytes of disk space inside the database. 
So '''one GB''' disk space is needed for ~'''516222 CDRs'''. 
One call may have one or multiple CDRs depending on the call flow, the used PBX objects and their configuration.


It is strongly recommended that you try to precalculate your required disk space and configure a suiting value under [[#Configure_scheduled_CDR_cleanup]]. 
Don't forget to configure the alarm server under [[Reference10:Concept_Linux_Application_Platform#Alarm_Server]] to receive an alarm if the disk is nearly full (10% disk space remaining).


==Installation==

Download the latest version of innovaphone reporting.

Log into the application platform, go to the Applications tag, click on [[ Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|Upload/Update]] and upload the downloaded file.
The installation will start automatically and the page will refresh every two seconds showing the installation process.
If there is no error during the installation you will see at the end "Installation was succesfull". Otherwise,
you will get "installation failed" and the reason why it went wrong.

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

==Configuration==
===Device===

====License====
It is required to have a Reporting license installed on your device. Check under [[ Reference10:General/License ]] if you already have one.

Set the Reporting flag for each PBX object, which should be reported on the objects properties page.

====CDR Gateway====
Any innovaphone device which sends [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDRs]] to the reporting application must have at least one CDR interface configured under [[ Reference10:Gateway/CDR ]]:

* Type: LOCAL-AP or REMOTE-AP/REMOTE-AP-S

If HTTP/HTTPS is selected then some other parameters must be set:

* Address: ip address of the application platform
* Port: 80 for REMOTE-AP
* Port: 443 for REMOTE-AP-S
* Method: POST/GET
* Path: ap/cdr.fcgi

The application platform is by default password protected, so you'll have to perform one of these steps: 

* configure an authenticated URL for '''ap/cdr.fcgi''' under [[ Reference10:Services/HTTP/Client ]] (recommended)
** If you configure an authenticated URL (with the linux webserver credentials), 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
* configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]]

Configure a second CDR interface, if you use [[#Replication|Replication]].

====Enable PBX CDRs====
Enable the "Generate CDRs" flag under [[ Reference10:PBX/Config/General ]].

===innovaphone Application Platform===

If the reporting URL/user/password is not configured in your device as authenticated URL, configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]].

===Database===

Reporting creates the innovaphone-reporting database to store CDRs sent from any innovaphone devices (appendix 7.6 explains the database structure).
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

Reporting creates the database user '''innovaphone-reporting''' with default password '''reporting'''.
This password may be changed at the innovaphone Reporting page under Config/Database.

====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 under Config/Database at the innovaphone reporting page.

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

====Delete CDRs====

You can delete CDRs for certain/all users in a certain timespan. If you enter '''%''' as object, all users are selected.

Note that PostgreSQL doesn't free the space on the disk! If you need free disk space, issue this command on the shell:
''sudo -u postgres vacuumdb -f innovaphone-reporting''
This may take some time and CDRs won't be received during this time.

====Configure scheduled CDR cleanup====

If you activate scheduled cleanup, CDRs older than the configured amount of months will be automatically deleted. 
The scheduled task is started once a day at 2 AM.

===PBX===

If you use multiple PBX devices which are not Master/Slave, you have to select, which identifier is unique for a user under Config/PBX:
* System Name (default)
* PBX Name

The selected value determines, which values are shown in the PBX dropdown box for report creation or report mail configuration.

===Replication===

You can configure a second innovaphone application platform with an installed innovaphone Reporting for replication purposes. 

* Mode:
** '''Off''': no replication
** '''Master''': the local server is the master server
** '''Standby''': the local server is the standby server, filters will be replicated from the master and can't be changed here
* Master/Standby Server: the IP address of the master or standby server
* Database password: the PostgreSQL database password of the other server (default is '''reporting''').
* Synchronisation interval: the interval in minutes (range 1-60) in which a sync is done

Now configure a second [[#CDR_Gateway|CDR Gateway]] for the standby server.

The current status can be seen here too. If the status is '''Failed''' take a look at the log file '''innovaphone Reporting Replication''' under [[ Reference10:Concept_Linux_Application_Platform#Logs|Diagnostics/Logs]] or look at the last trace output at the bottom of the page.
 
 
How replication works is described [[#Replication_2|here]].

===Ldap===

Several LDAP servers and dialing locations can be configured here. 

PBX field must correspond to a name of a PBX since PBX's names are available in CDRs. The received CDR is parsed to get the PBX name and this name will be used to find the corresponding LDAP server and dialing location needed to resolve names.

Each configured LDAP server and dialing location can be activated/deactivated with the '''active''' flag.

[[Image:ldap_update.png]]

If the country where you configure LDAP does not have Trunk/National prefix you should leave "National Prefix" and "Area Code" empty.

In the number Attributes field please do '''not''' add any additional characters to the attributes like ":P", ":D" or "@", for instance "homePhone:P, mobile:M, telephoneNumber:D". This does not work. That would be correct: "homePhone, mobile, telephoneNumber"

LDAP Internal Search flag allows reporting to perform name resolution also for internal numbers.

Search Base H323 checkbox means that h323 field of the CDR user will be used inside the LDAP Filter to resolve the telephone number.

===Report Mails===

Automatic report generation can be configured here:

* '''time''': daytime at which the report is sent
* '''user reports''':
** Creates for each matching user a separate report
** Users are matched by '''Object (Long Name)'''
** A user report only contains calls for this user
** The email address of the user is built by its '''H323 name''' and the '''System Name''' of its PBX (h323@systemname) or determined by the E-Mail field of the user
* '''interval''':
** daily: Mail will be send daily with the automatic period "last day"
** weekly: Mail will be send weekly with the automatic period "last week"
** monthly: Mail will be send daily with the automatic period "last month"
* '''day''': the day, at which the report is sent
* '''mail adresses''': recipients of the report (comma separated)
* '''Sender E-Mail address''': sender email address, which may be present as [[ Reference10:Concept_Linux_Application_Platform#Relay_Hosts | relay host ]]
* '''compress''': compress the attachment or not
* '''sort by'''
* '''sort order'''
* '''language'''
* '''send time''': the time of a day, when the report is sent

The explanation for the other settings can be found [[ #Report_Creation | here. ]] 

[[Image:mails.png]]

===Users===

You can configure multiple users, who shall have access to reports without having access to the whole reporting configuration. 
The user can login with his user name and password on: 

http(s)://Linux-IP/apps/innovaphone-reporting/user/login.php

The admin can assign one or more base filters to the user. A base filter is explained [[ #Base_filter | here]]. 
If the user creates new reports, new own filters or report mails, he '''has''' to use one of his assigned base filters.

If you are using multiple PBX systems, the user has only access to these systems, which are configured in the base filters of the user.
If the user has no base filter with a limitation to a certain "System Name"/"PBX Name" (depends on your [[ #PBX | PBX configuration ]]),
he will have access to all systems!

[[Image:users.jpg]]

====User Login====

A logged in user can create reports, own filters and report mails based on his assigned base filters.

[[Image:Userlogin.jpg]]

===Images===

You may upload images to be used as logo or footer in pdf reports. 

Logos must be 32x32 and footer can have a maximum width of 450 pixels and a maximum height of 50 pixels. 

These images can have jpeg or png format. 

===Relay CDRs===

Relay CDRs can be stored in log files by the Reporting application. Configure a CDR gateway as already described and relay CDRs will be written to the webdav file '''/cdr/cdr.txt'''.
The file is rotated on 1 MB size. The first rotated file is uncompressed, further files will be gz compressed. Max ten files are kept. Older files will be deleted: 
* cdr.txt
* cdr.txt.1
* cdr.txt.2.gz
* cdr.txt.3.gz
* cdr.txt.4.gz
* cdr.txt.5.gz
* cdr.txt.6.gz
* cdr.txt.7.gz
* cdr.txt.8.gz
* cdr.txt.9.gz

===innovaphone-reporting web access===

You can configure a separate authentication for the innovaphone-reporting web site [[Reference10:Concept_Linux_Application_Platform#Change_application_access_credentials|here]]. 
One can just login on the reporting site with this access.

===Integration Voice recorder===

The innovaphone voice recording can be integrated and a remote control of the player is possible, see relative article.

==Filters==
===General===

Filters are set up to create reports based on certain conditions. A filter can have multiple conditions and multiple filters can be combined on report creation (combine is performed with an '''OR'''). 
A filter has a unique '''name''' with an optional '''description'''.

===Conditions===

[[Image:filter.png]]

There are five or seven condition sections depending on what is selected under '''States'''. Conditions inside same section are '''OR''' associated while different sections are '''AND''' associated.
 

(Object == Terra '''OR''' Object == Uranus) '''AND''' (PBX == sifi) '''AND''' (Number == 0049%)

====Base filter====

If you select another filter as base filter, the conditions of the base filter are implicitly '''AND''' conjuncted, when the current filter is used. 
So if the base filter defines two PBX values, e.g. "Berlin" and "Hamburg" and the current filter defines one PBX value, e.g. "Berlin", only objects of the PBX "Berlin" will be filtered: 

(pbx="Berlin") AND (pbx="Berlin" OR pbx="Hamburg")

If a user defines an own filter for his reports, he has to use a base filter, which he is allowed to use. So each filter, which he uses, will have at least one base filter condition, which the admin has defined.

You have to take care with the conditions of the current filter and the base filter,
as it is now easy to create a filter with mutually exclusive conditions, e.g. if
the filter has pbx="Berlin" and the base filter pbx="Hamburg" => no matching records.

====Anonym====

If you check this flag, a report created with this filter or with a filter, where this filter is a basefilter, will by anonymized.

====Local====

Define one ore more conditions for the local party, defined by:

* Object: the cn/PBX object name
* Number: the number
* Groups: a group of the PBX object

====Remote====

Define one or more conditions for the remote party, defined by:

* Number: the number
* Remote display name: the display name

====PBX====

Define one ore more conditions for the PBX, defined by:

* PBX: the PBX name
* Node: the node name

====States====

* No Response
* Connected
* Busy
* No Channel

====Directions====

* Incoming
* Outgoing
* Transfer: calls, which have been transferred to the current local party
* Call Forward: calls, which have been forwarded to the current local party

====Call Duration====

Time the call was connected.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or No Response is unselected, then the filter will search for Connected calls with connected time greater or smaller than '''Call Duration'''.

====Alert Duration====

Time the call was ringing independent of the status of the call afterwards.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or Connected is unselected, then the filter will search only for Not Connected Calls that were ringing more or less time than '''Alert Duration'''.

====Report times====

Define the time where calls should be counted. 
You can optionally define the weekday(s) of calls.

====Images====

* Logo: This must be 32x32 pixel image in jpeg or png format. 
* Footer: Maximum width of 450 pels and maximum height of 50 pels. Also jpeg or png format. 

====Using Patterns====

You can use these [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]] for every condition.

==Report Creation==
===General===

It is possible to generate call lists for single users or more complex reports by means of filters.

===Web Interface===

Reporting application provides a web interface to generate reports.

[[Image:Report_hide.png]]

* '''PBX''': select the PBX for the report. The values of the drop down box depend on your [[#PBX | PBX configuration]]
* '''Object (Long Name)''': corresponds to the PBX Long Name assigned to a specific user (% is a special postgresql character, which matches any string)
* '''Filter''': one or multiple filters can be defined ('''OR''' joined)
* '''Group by''': the result can be grouped by Date or Object
* '''Hide last X digits''': you may replace the last digits of an external number with a '*'.
** LDAP must be configured in order to use this capability but if you want no LDAP funtionality, just unset the Active Box in LDAP.
** Actually, the pbx/phys value of a call is matched against the LDAP pbx value and if the number starts with the external line prefix.
* '''Anonym''': do not show internal names/numbers
** If anonym is set, hide last digits is set to 3, if not set
* '''Filter Info''': the report will contain information about the configured settings and filter information
* '''Displayed Duration''':
** Call Duration (Total): the total call duration, e.g. with the duration of a subsequent transfer
** Call Duration (User): just the time, the user was connected
** Billing Duration: the duration, a user must be billed for
** None of these durations contain the alert duration, which is separatly listed

[[Image:reporting_report.png | A normal report. The summary shows incoming / outgoing summaries]]

[[Image:grouped_report.png | A grouped report. Each group has an own summary]]

====Print====

Click the print icon to open a printable version of the report.

====Save====
You can save the report as '''pdf''' or as '''xml''' by using the corresponding icon. 
You can also download a report in '''csv''' format without call history. The report uses '''comma''' as delimeter character, '''"''' as text qualifier and '''PBX Object/Remote Party''' columns should be defined as Text (avoid telephone numbers to be considered as numbers by Excel). '''UTF-8''' must be used as character set. 

====Sorting====

Each sortable column has a clickable column head. This sorting will be also used when opening the printable version or saving the report as PDF.

====Icons====
The icons are explained in the [[#Call list icons|appendix]].

===Remote Interface===

See [[#Remote_Interface_2|Remote Interface Appendix]]

==Backup and Restore==

You can both manually and automatically backup the database and configuration files for Reporting under [[Reference10:Concept_Linux_Application_Platform#Backup|Administration/Backup]] in the application platform.

Configuration details for the update server can be found [[Reference10:Concept_Linux_Application_Platform#Backup|here]].

===Configuration Files===

'''saveinnovaphone-reportingcfgs''' is the command used to automatically save configuration files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

===Data===

'''saveinnovaphone-reportingdb''' is the command to automatically backup the whole innovaphone Reporting database with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

If you restore the reporting database, you should keep in mind, that this might take several hours for a system
on a CF card, depending on the size of the restored database. The backup process itself is quite fast with a few minutes.

===Logs===

'''saveinnovaphone-reportinglogs''' to save log files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

==Appendix==
===PostgreSQL Patterns===
For filter conditions or for the pbx object value you can use the following patterns inside a string:

* '''%''': matches any string of zero or more characters
* '''_''': matches any single character

Example:
'''Sat%''' will match all pbx objects, which start with the string '''Sat'''.

We do always perform case insensitiv searches!

===innovaphone Reporting XML===
<code type="xml">
<?xml version="1.0" encoding="utf-8"?>
<application>
<name>innovaphone Reporting</name>
<desc>Reporting software</desc>
<directory>innovaphone-reporting</directory>
<href>report.php</href>
<linux-username>innovaphone-reporting</linux-username>
<packages>
<package>php5-gd</package>
<package>php5-ldap</package>
</packages>
<database name="innovaphone-reporting" username="innovaphone-reporting"/>
<cronjobs>
<cronjob script="/etc/cron.d/reporting_replication"/>
<cronjob script="/etc/cron.d/reporting_cleanup"/>
<cronjob script="/etc/cron.d/reporting_mails"/>
</cronjobs>
<log-files>
<log title="Postgresql-8.4" no-clear="true">/var/log/postgresql/postgresql-8.4-main.log</log>
<log title="Reporting cleanup">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_cleanup.log</log>
<log title="innovaphone Reporting">/var/www/innovaphone/apps/innovaphone-reporting/log/innovaphone-reporting.log</log>
<log title="innovaphone Reporting Replication">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_replication.log</log>
</log-files>
<config-files>
<conf>/etc/postgresql/8.4/main/pg_hba.conf</conf>
<conf>/etc/postgresql/8.4/main/postgresql.conf</conf>
<conf>/home/innovaphone-reporting/reporting.conf</conf>
<conf>/home/root/ssl_cert/server.key</conf>
<conf>/home/root/ssl_cert/server.crt</conf>
<conf>/etc/cron.d/reporting_replication</conf>
<conf>/etc/cron.d/reporting_cleanup</conf>
<conf>/etc/cron.d/reporting_mails</conf>
<conf>/var/www/innovaphone/apps/innovaphone-reporting/report_images</conf>
</config-files>
<backup>
<command title="Save innovaphone Reporting configuration files" cmd="saveinnovaphone-reportingcfgs" script=""/>
<command title="Save innovaphone Reporting database" cmd="saveinnovaphone-reportingdb" script=""/>
<command title="Save innovaphone Reporting log files" cmd="saveinnovaphone-reportinglogs" script=""/>
</backup>
<restore>
<command title="Restore innovaphone Reporting configuration files" cmd="restoreinnovaphone-reportingcfgs" script="">
<action>/etc/init.d/postgresql restart</action>
<action>/etc/init.d/cron restart</action>
</command>
<command title="Restore innovaphone Reporting database" cmd="restoreinnovaphone-reportingdb" script=""/>
</restore>
<uninstall script="/usr/bin/sudo /usr/local/bin/uninstall_script.sh -f 'innovaphone-reporting.xml' -linux_user yes -linux_group yes -database yes -database_user yes -log_script '/var/www/innovaphone/log/appl_uninstall.log'">
<to-delete>
<to-del path="/usr/local/bin/reporting_cleanup.sh"/>
<to-del path="/usr/local/bin/reporting_replication.out"/>
<to-del path="/usr/local/bin/reporting_replication.sh"/>
<to-del path="/home/innovaphone-reporting/tmp"/>
</to-delete>
</uninstall>
<lighttpd-auth>1</lighttpd-auth>
<public-web-paths>
<path>mypbx</path>
<path>user</path>
</public-web-paths>
</code>

===Installed Debian Packages===

The following packages (and their dependencies) are installed with innovaphone Reporting:

* php5-gd
* php5-ldap

===Configuration Files===

pg_hba.conf is the client authentication configuration file and controls which hosts are allowed to connect, how clients
are authenticated, which PostgreSQL user names they can use and which databases they can access.

postgresql.conf is the PostgreSQL configuration file

===Data Files===

If you backup the innovaphone reporting database, you'll get a gz archiv, which contains the whole innovaphone-reporting database.

===Report XML and CSV===
The field description below applies for the '''XML''' and '''CSV''' columns!

<code type="xml">
<report>
<record>
....
<time time="1301303966" utc="1301303966">2011-03-28 11:19:26</time>
<obj>Saturn</obj>
<id>870998fee909d311b2ec009033105dc9</id>
<call>int</call>
<alert-duration seconds="0">0:00</alert-duration>
<flow>
<ev caller="ep1" ep1_number="101" ep1_name="saturn" ep1_dn="Saturn"
ep2_number="102" ep2_name="uranus" ep2_dn="Uranus" status="co" entry="true"/>
</flow>
<call-duration seconds="2">0:02</call-duration>
<billing-duration seconds="2">0:02</billing-duration>
<conn-duration seconds="2">0:02</conn-duration>
<groups>
<group>test</group>
<group>test2</group>
</groups>
<node>root</node>
<pbx>.</pbx>
<cause></cause>
<dir>o</dir>
<status>co</status>
<type/>
<remote number="102" name="uranus" dn="Uranus"/>
<callback number="456" name="abc" dn="123" time="1301305962">2011-03-28 11:52:42</callback>
</record>
....
</report>
</code>

* time: the node contains a formatted time string of the local time
** attribute '''time''' is a unix timestamp (referring to the local time stamp of the CDR)
** attribute '''utc''' is a unix timestamp (referring to the utc time stamp of the CDR)
* obj: the PBX object name (also called cn)
* id: the conference id of the call
* call: '''int''' (internal) or '''ext''' (external) call
* flow '''(XML only)''': the call flow
** ev
***ep1 (ep1_number, ep1_name, ep1_dn): the left side of the call
***ep2 (ep2_number, ep2_name, ep2_dn): the right side of the call
***caller: '''ep1''', '''ep2''' or empty, if unknown
***status: '''co''' (connected), '''al''' (alert), '''er''' (error) or '''bu''' (busy) state of the current event
***entry: '''true''' for the entry event of the local object
***type: '''cf''' (call forward), '''ct''' (call transfer)
* Original Called '''(CSV only)''': In case of Call flow; The original called device
* Diverting '''(CSV only)''': In case of Call flow; The diverting device
* Transferring '''(CSV only)''': In case of Call flow; The transferring device
* groups '''(XML only)''': the groups of the PBX object
* node: the node of the PBX object
* pbx: the pbx of the PBX object
* cause: the decimal disconnect reason of the call (see [[Reference:ISDN_Cause_Codes]])
* remote:
** outgoing calls -> dialed endpoint
** incoming calls -> first ep2 above entry event or entry event if this is the first one
** incoming calls with incoming transfer after entry event -> transfer target
* status:
** outgoing calls -> best found status in call flow
** incoming calls -> status of entry event
* type: the type of the entry event or, if not set, the type of the next event, if given
** empty: direct call
** '''ct''': call transfer
** '''cf''': call forward
** '''cct''': call transfer with consultation
** '''pu''': call pickup
* dir: o (outgoing) if the first event is the entry event and the caller is ep1
* dir: i (incoming) if not o
* alert-duration: alert time
*Billing Duration: the duration, a user must be billed for
** outgoing call -> duration from the first event until the last event in the flow
** incoming call -> duration from the first transfer/forward event until the last event in the flow
* call-duration/Call Duration (Total): duration of the whole call, e.g. with the duration of a subsequent transfer
* conn-duration/Call Duration (User): just the time, the user was connected. Duration from the entry event until the event, where the local endpoint isn't connected any more
* callback: '''name''', '''number''', '''dn''' and '''time''' if this call has been callbacked using mypbx (time referrs to the UTC time of the callback)
* Further Registration: If more than one devices is registered to the same object, each device creates a CDR. This field identifies the additional CDRs for the same call
* Object Info '''(CSV only)''': combination of object names and number
* Date '''(CSV only)''': extracted date only from the time_string
* Time_2 '''(CSV only)''': extracted time only from the time_string

===Database Structure===

====cdrs====
Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDR]])

This section is composed by four tables: cdrs, events, groups and cdr_properties.
The first three tables contain the corresponding fields to store the information contained in the cdr, event and group tags. 
Each CDR represents the call in the view of one PBX object. So there might be multiple CDRs for one call if multiple PBX objects are used within the call.

* '''cdr fields:''' id, guid, sys, pbx, node, device, cn, e164, h323, dir, utc, local.
* '''event fields:''' id, msg, type, e164, h323, conf, cause, time, cdr_id, order_index.
* '''group fields:''' id, name, active, type, cdr_id.

'''id''' field is assigned by postgresql for each entry and has nothing to do with the information present in the cdr. It is different for each entry inside the table.

The events table has two additional fields, called cdr_id, to associate these events to the corresponding cdr entry and order_index to keep their position inside the cdr.
Groups table has also the cdr_id field to associate the group entries to the corresponding cdr and events entries.

The '''cdr_properties''' table contains relevant information associated with the call such as call_length, alert_length or call_flow. It also presents a cdr_id field.

====filters====

This section is composed by three tables: filter_columns, filter_conditions and filters.

* '''filter_columns''' is not used for the time being. This is supposed to contain the columns the user wants to see in his report, but right now, just default columns (Time/Object/Duration/Left/Direction/State/Right) are shown.
* '''filter''' contains the filter name and description plus two conditions call_state (No Response, Connected, Busy and No Channel) and direction (Incoming, Outgoing, Transfer and Call Forward).
* '''filter_conditions''' contains the defined conditions for a filter

All three tables are related through an id.

====cdr_users====

This table contains a timestamp '''missed_calls_time''' for the last report access by a user '''cn''' + ('''pbx''' OR '''sys''') with mypbx. It is used to retrieve information about missed calls since the last use of mypbx. 
The timestamp '''clear_report_time''' indicates the last clearance time. 
email, sys (system name) and pbx (PBX name) are also stored for each user.

====replication====

Contains information of the last replication run, which is used to sync master/standby installations.

===Replication===

The replication between the master and standby servers is divided into two steps:

====CDRs====
Both master and standby server keep an information about the last replicated CDR. From this CDR on, they retrieve all CDR guids (32 bytes) from all new CDRs from the other server. If a guid already exists in the local database, the CDR is skipped, otherwise it is replicated. 
So there is a minimal data exchange for already existing CDRs and each new CDR is only processed once.

====Filters/LDAP/Report Mails/Users====
The master server does nothing here, but the '''standby''' deletes all filters, LDAP servers, report mails and users and replicates all from the master. 
So these items from the master server can be used, but not changed, on the standby server.

===Remote Interface===

You can retrieve the PDF/XML/CSV report with a remote interface. 
Make a POST or GET HTTP request to '''http(s)://Linux-IP/apps/innovaphone-reporting/report.php''' with the following parameters:

* remote: mandatory for a remote request!
** '''1'''
* from : the from date/time as UNIX timestamp '''OR''' date/time string as described [ http://www.php.net/manual/de/datetime.formats.php | here ].
* to: the to date/time (format see '''from''')
* [format]: the return format, allowed values:
** '''xml''': default
** '''pdf'''
** '''csv'''
* [sortby] : the report sorting, allowed values:
** '''time''': default
** '''obj''': sort by pbx object name
** '''call-duration'''
** '''alert-duration'''
** '''dir''': sort by call direction
* [sortorder]: the report sort order, allowed values:
** '''ascending''': default
** '''descending'''
* [groupby]: report grouping
** default empty/not set: no grouping
** '''local_stamp''': group by time
** '''cn''': group by pbx object name
* [hidedigits]: hide the last X digits of external numbers
* pbx: search for this PBX (mandatory!)
* pbxobject: search for this PBX object (you can leave this, if you use filterX)
* filterX: use a filter with its name. You can use multiple filters with filter1=test, filter2=test2...
* [filterinfo]: show the filter information in a created report ("true" or "false")
* [lang]: the language, e.g. "en" or "de"
* [displayedduration]:
** '''call_duration''': default Call Duration (Total)
** '''conn_duration''': Call Duration (User)
** '''billing_duration''': Billing Duration
* [anonym]: anonymize internal names/numbers ("true" or "false")
* [bulk]: creates user reports (see [[ #Report_Mails | Report Mails ]])
* [sender]: sender email adress of the report
* [confid]: query calls of a certain conference ID
** you can omit the following fields, if using confid: '''from''', '''to''', '''pbx''', '''pbxobject''', '''filterX'''

Parameters in [] are optional.

'''pbxobject''' supports [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]].

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&pbxobject=Saturn
Gets all records between 2011-03-29 and 2011-03-30 for the pbx object Saturn.

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&filter1=test&filter2=test2
Gets all records between 2011-03-29 and 2011-03-30 for the filters test and test2.

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

====PGAdmin====

[http://www.pgadmin.org/ PGAdmin] is an administration tool for PostgreSQL databases.

====Putty====

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

===Call list icons===
The direction of the icon arrow depends on the call flow.

* [[Image:reporting_conn.jpg]]: a connected call
* [[Image:reporting_busy.jpg]]: busy destination
* [[Image:reporting_no_res.jpg]]: no response from destination
* [[Image:reporting_error.jpg]]: an error occurred, like "no channel available" during the call setup
* [[Image:reporting_ct.jpg]]: call transfer
* [[Image:reporting_cct.jpg]]: call transfer with consultation
* [[Image:reporting_cf.jpg]]: call forward
* [[Image:Reporting_pickup.jpg]]: call pickup (or SOAP redirect)
* [[Image:reporting_dir.jpg]]: call direction

A small arrow on a call state icon indicates a callback done with mxPBY, e.g.:
* [[Image:reporting_busy_callback.jpg]]

==Known Problems==
===Replication===
====Callback information====
The callback information get lost in the following scenario:
* The callback CDR is already replicated on both master and standby
* Master or standby is down
* A user calls back the CDR from point 1

====Missed calls====
The information for missed calls is not replicated. So the first time, a standby server is used with mypbx, the missed calls information will be wrong. The second time will be correct again.

===CDRs===
If the innovaphone Reporting is not running, for whatever reaseon, the device, which sends CDRs, currently stores up to 300kB CDRs data. So if one CDR has up to 2kB, 150 CDRs can be stored until the innovaphone Reporting should be up again, to avoid data loss.

===Missing values for PBX drop down box===
If your database currently contains no CDRs of one of your PBX systems, you won't be able to select this system as PBX for report creation or report mail configuration!

===Restoring Database with more than 2GB===

When restoring database using the web browser there is a 2GB upload limit, so if our database have a bigger size the upload will fail.

As alternative solution (if there is enough space):

1. Copy the gz database dump to the webdav folder
2. Uncompress this dump: /bin/gzip -cd /var/www/innovaphone/webdav/dump.gz --uncompress > /tmp/db.dump
3. Start the restore: /usr/local/bin/config.sh postgres db-restore /tmp/pg_schema.dump /tmp/db.dump innovaphone-reporting
4. be patient, this might take a while
5. delete /tmp/db.dump, /var/www/innovaphone/webdav/dump.gz and /tmp/pg_schema.dump (automatically created)

===PDF generation for many CDRs may fail===
You may experience a '''Server error 500''' if you generate PDFs with many CDRs. The PDF library which is used to generate the PDFs fails.
Please generate multiple PDFs with a smaller timespan in such a case.

== Related Articles ==

[[Howto:Integration_reporting_and_voice_recording]]

[[Category:Concept|Reporting]]

File:Webdav.png

2016-11-23T14:57:55Z

Tle:

File:Save.png

2016-11-23T14:57:46Z

Tle:

File:Restore.png

2016-11-23T14:57:24Z

Tle:

File:Reporting.png

2016-11-23T14:57:14Z

Tle:

Reference10:Concept Reporting

2016-11-23T14:56:28Z

Tle: /* Backup and Restore */

==Requirements==

It is needed to have the [[Reference10:Concept_Linux_Application_Platform|application platform]] installed and running.

===Calculation of required disk space===

An average CDR requires 2080 bytes of disk space inside the database. 
So '''one GB''' disk space is needed for ~'''516222 CDRs'''. 
One call may have one or multiple CDRs depending on the call flow, the used PBX objects and their configuration.


It is strongly recommended that you try to precalculate your required disk space and configure a suiting value under [[#Configure_scheduled_CDR_cleanup]]. 
Don't forget to configure the alarm server under [[Reference10:Concept_Linux_Application_Platform#Alarm_Server]] to receive an alarm if the disk is nearly full (10% disk space remaining).


==Installation==

Download the latest version of innovaphone reporting.

Log into the application platform, go to the Applications tag, click on [[ Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|Upload/Update]] and upload the downloaded file.
The installation will start automatically and the page will refresh every two seconds showing the installation process.
If there is no error during the installation you will see at the end "Installation was succesfull". Otherwise,
you will get "installation failed" and the reason why it went wrong.

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

==Configuration==
===Device===

====License====
It is required to have a Reporting license installed on your device. Check under [[ Reference10:General/License ]] if you already have one.

Set the Reporting flag for each PBX object, which should be reported on the objects properties page.

====CDR Gateway====
Any innovaphone device which sends [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDRs]] to the reporting application must have at least one CDR interface configured under [[ Reference10:Gateway/CDR ]]:

* Type: LOCAL-AP or REMOTE-AP/REMOTE-AP-S

If HTTP/HTTPS is selected then some other parameters must be set:

* Address: ip address of the application platform
* Port: 80 for REMOTE-AP
* Port: 443 for REMOTE-AP-S
* Method: POST/GET
* Path: ap/cdr.fcgi

The application platform is by default password protected, so you'll have to perform one of these steps: 

* configure an authenticated URL for '''ap/cdr.fcgi''' under [[ Reference10:Services/HTTP/Client ]] (recommended)
** If you configure an authenticated URL (with the linux webserver credentials), 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
* configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]]

Configure a second CDR interface, if you use [[#Replication|Replication]].

====Enable PBX CDRs====
Enable the "Generate CDRs" flag under [[ Reference10:PBX/Config/General ]].

===innovaphone Application Platform===

If the reporting URL/user/password is not configured in your device as authenticated URL, configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]].

===Database===

Reporting creates the innovaphone-reporting database to store CDRs sent from any innovaphone devices (appendix 7.6 explains the database structure).
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

Reporting creates the database user '''innovaphone-reporting''' with default password '''reporting'''.
This password may be changed at the innovaphone Reporting page under Config/Database.

====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 under Config/Database at the innovaphone reporting page.

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

====Delete CDRs====

You can delete CDRs for certain/all users in a certain timespan. If you enter '''%''' as object, all users are selected.

Note that PostgreSQL doesn't free the space on the disk! If you need free disk space, issue this command on the shell:
''sudo -u postgres vacuumdb -f innovaphone-reporting''
This may take some time and CDRs won't be received during this time.

====Configure scheduled CDR cleanup====

If you activate scheduled cleanup, CDRs older than the configured amount of months will be automatically deleted. 
The scheduled task is started once a day at 2 AM.

===PBX===

If you use multiple PBX devices which are not Master/Slave, you have to select, which identifier is unique for a user under Config/PBX:
* System Name (default)
* PBX Name

The selected value determines, which values are shown in the PBX dropdown box for report creation or report mail configuration.

===Replication===

You can configure a second innovaphone application platform with an installed innovaphone Reporting for replication purposes. 

* Mode:
** '''Off''': no replication
** '''Master''': the local server is the master server
** '''Standby''': the local server is the standby server, filters will be replicated from the master and can't be changed here
* Master/Standby Server: the IP address of the master or standby server
* Database password: the PostgreSQL database password of the other server (default is '''reporting''').
* Synchronisation interval: the interval in minutes (range 1-60) in which a sync is done

Now configure a second [[#CDR_Gateway|CDR Gateway]] for the standby server.

The current status can be seen here too. If the status is '''Failed''' take a look at the log file '''innovaphone Reporting Replication''' under [[ Reference10:Concept_Linux_Application_Platform#Logs|Diagnostics/Logs]] or look at the last trace output at the bottom of the page.
 
 
How replication works is described [[#Replication_2|here]].

===Ldap===

Several LDAP servers and dialing locations can be configured here. 

PBX field must correspond to a name of a PBX since PBX's names are available in CDRs. The received CDR is parsed to get the PBX name and this name will be used to find the corresponding LDAP server and dialing location needed to resolve names.

Each configured LDAP server and dialing location can be activated/deactivated with the '''active''' flag.

[[Image:ldap_update.png]]

If the country where you configure LDAP does not have Trunk/National prefix you should leave "National Prefix" and "Area Code" empty.

In the number Attributes field please do '''not''' add any additional characters to the attributes like ":P", ":D" or "@", for instance "homePhone:P, mobile:M, telephoneNumber:D". This does not work. That would be correct: "homePhone, mobile, telephoneNumber"

LDAP Internal Search flag allows reporting to perform name resolution also for internal numbers.

Search Base H323 checkbox means that h323 field of the CDR user will be used inside the LDAP Filter to resolve the telephone number.

===Report Mails===

Automatic report generation can be configured here:

* '''time''': daytime at which the report is sent
* '''user reports''':
** Creates for each matching user a separate report
** Users are matched by '''Object (Long Name)'''
** A user report only contains calls for this user
** The email address of the user is built by its '''H323 name''' and the '''System Name''' of its PBX (h323@systemname) or determined by the E-Mail field of the user
* '''interval''':
** daily: Mail will be send daily with the automatic period "last day"
** weekly: Mail will be send weekly with the automatic period "last week"
** monthly: Mail will be send daily with the automatic period "last month"
* '''day''': the day, at which the report is sent
* '''mail adresses''': recipients of the report (comma separated)
* '''Sender E-Mail address''': sender email address, which may be present as [[ Reference10:Concept_Linux_Application_Platform#Relay_Hosts | relay host ]]
* '''compress''': compress the attachment or not
* '''sort by'''
* '''sort order'''
* '''language'''
* '''send time''': the time of a day, when the report is sent

The explanation for the other settings can be found [[ #Report_Creation | here. ]] 

[[Image:mails.png]]

===Users===

You can configure multiple users, who shall have access to reports without having access to the whole reporting configuration. 
The user can login with his user name and password on: 

http(s)://Linux-IP/apps/innovaphone-reporting/user/login.php

The admin can assign one or more base filters to the user. A base filter is explained [[ #Base_filter | here]]. 
If the user creates new reports, new own filters or report mails, he '''has''' to use one of his assigned base filters.

If you are using multiple PBX systems, the user has only access to these systems, which are configured in the base filters of the user.
If the user has no base filter with a limitation to a certain "System Name"/"PBX Name" (depends on your [[ #PBX | PBX configuration ]]),
he will have access to all systems!

[[Image:users.jpg]]

====User Login====

A logged in user can create reports, own filters and report mails based on his assigned base filters.

[[Image:Userlogin.jpg]]

===Images===

You may upload images to be used as logo or footer in pdf reports. 

Logos must be 32x32 and footer can have a maximum width of 450 pixels and a maximum height of 50 pixels. 

These images can have jpeg or png format. 

===Relay CDRs===

Relay CDRs can be stored in log files by the Reporting application. Configure a CDR gateway as already described and relay CDRs will be written to the webdav file '''/cdr/cdr.txt'''.
The file is rotated on 1 MB size. The first rotated file is uncompressed, further files will be gz compressed. Max ten files are kept. Older files will be deleted: 
* cdr.txt
* cdr.txt.1
* cdr.txt.2.gz
* cdr.txt.3.gz
* cdr.txt.4.gz
* cdr.txt.5.gz
* cdr.txt.6.gz
* cdr.txt.7.gz
* cdr.txt.8.gz
* cdr.txt.9.gz

===innovaphone-reporting web access===

You can configure a separate authentication for the innovaphone-reporting web site [[Reference10:Concept_Linux_Application_Platform#Change_application_access_credentials|here]]. 
One can just login on the reporting site with this access.

===Integration Voice recorder===

The innovaphone voice recording can be integrated and a remote control of the player is possible, see relative article.

==Filters==
===General===

Filters are set up to create reports based on certain conditions. A filter can have multiple conditions and multiple filters can be combined on report creation (combine is performed with an '''OR'''). 
A filter has a unique '''name''' with an optional '''description'''.

===Conditions===

[[Image:filter.png]]

There are five or seven condition sections depending on what is selected under '''States'''. Conditions inside same section are '''OR''' associated while different sections are '''AND''' associated.
 

(Object == Terra '''OR''' Object == Uranus) '''AND''' (PBX == sifi) '''AND''' (Number == 0049%)

====Base filter====

If you select another filter as base filter, the conditions of the base filter are implicitly '''AND''' conjuncted, when the current filter is used. 
So if the base filter defines two PBX values, e.g. "Berlin" and "Hamburg" and the current filter defines one PBX value, e.g. "Berlin", only objects of the PBX "Berlin" will be filtered: 

(pbx="Berlin") AND (pbx="Berlin" OR pbx="Hamburg")

If a user defines an own filter for his reports, he has to use a base filter, which he is allowed to use. So each filter, which he uses, will have at least one base filter condition, which the admin has defined.

You have to take care with the conditions of the current filter and the base filter,
as it is now easy to create a filter with mutually exclusive conditions, e.g. if
the filter has pbx="Berlin" and the base filter pbx="Hamburg" => no matching records.

====Anonym====

If you check this flag, a report created with this filter or with a filter, where this filter is a basefilter, will by anonymized.

====Local====

Define one ore more conditions for the local party, defined by:

* Object: the cn/PBX object name
* Number: the number
* Groups: a group of the PBX object

====Remote====

Define one or more conditions for the remote party, defined by:

* Number: the number
* Remote display name: the display name

====PBX====

Define one ore more conditions for the PBX, defined by:

* PBX: the PBX name
* Node: the node name

====States====

* No Response
* Connected
* Busy
* No Channel

====Directions====

* Incoming
* Outgoing
* Transfer: calls, which have been transferred to the current local party
* Call Forward: calls, which have been forwarded to the current local party

====Call Duration====

Time the call was connected.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or No Response is unselected, then the filter will search for Connected calls with connected time greater or smaller than '''Call Duration'''.

====Alert Duration====

Time the call was ringing independent of the status of the call afterwards.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or Connected is unselected, then the filter will search only for Not Connected Calls that were ringing more or less time than '''Alert Duration'''.

====Report times====

Define the time where calls should be counted. 
You can optionally define the weekday(s) of calls.

====Images====

* Logo: This must be 32x32 pixel image in jpeg or png format. 
* Footer: Maximum width of 450 pels and maximum height of 50 pels. Also jpeg or png format. 

====Using Patterns====

You can use these [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]] for every condition.

==Report Creation==
===General===

It is possible to generate call lists for single users or more complex reports by means of filters.

===Web Interface===

Reporting application provides a web interface to generate reports.

[[Image:Report_hide.png]]

* '''PBX''': select the PBX for the report. The values of the drop down box depend on your [[#PBX | PBX configuration]]
* '''Object (Long Name)''': corresponds to the PBX Long Name assigned to a specific user (% is a special postgresql character, which matches any string)
* '''Filter''': one or multiple filters can be defined ('''OR''' joined)
* '''Group by''': the result can be grouped by Date or Object
* '''Hide last X digits''': you may replace the last digits of an external number with a '*'.
** LDAP must be configured in order to use this capability but if you want no LDAP funtionality, just unset the Active Box in LDAP.
** Actually, the pbx/phys value of a call is matched against the LDAP pbx value and if the number starts with the external line prefix.
* '''Anonym''': do not show internal names/numbers
** If anonym is set, hide last digits is set to 3, if not set
* '''Filter Info''': the report will contain information about the configured settings and filter information
* '''Displayed Duration''':
** Call Duration (Total): the total call duration, e.g. with the duration of a subsequent transfer
** Call Duration (User): just the time, the user was connected
** Billing Duration: the duration, a user must be billed for
** None of these durations contain the alert duration, which is separatly listed

[[Image:reporting_report.png | A normal report. The summary shows incoming / outgoing summaries]]

[[Image:grouped_report.png | A grouped report. Each group has an own summary]]

====Print====

Click the print icon to open a printable version of the report.

====Save====
You can save the report as '''pdf''' or as '''xml''' by using the corresponding icon. 
You can also download a report in '''csv''' format without call history. The report uses '''comma''' as delimeter character, '''"''' as text qualifier and '''PBX Object/Remote Party''' columns should be defined as Text (avoid telephone numbers to be considered as numbers by Excel). '''UTF-8''' must be used as character set. 

====Sorting====

Each sortable column has a clickable column head. This sorting will be also used when opening the printable version or saving the report as PDF.

====Icons====
The icons are explained in the [[#Call list icons|appendix]].

===Remote Interface===

See [[#Remote_Interface_2|Remote Interface Appendix]]

==Backup and Restore==

You can both manually and automatically backup the database and configuration files for Reporting under [[Reference10:Concept_Linux_Application_Platform#Backup|Administration/Backup]] in the application platform.

Configuration details for the update server can be found [[Reference10:Concept_Linux_Application_Platform#Backup|here]].

===Configuration Files===

'''saveinnovaphone-reportingcfgs''' is the command used to automatically save configuration files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

===Data===

'''saveinnovaphone-reportingdb''' is the command to automatically backup the whole innovaphone Reporting database with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

If you restore the reporting database, you should keep in mind, that this might take several hours for a system
on a CF card, depending on the size of the restored database. The backup process itself is quite fast with a few minutes.

===Logs===

'''saveinnovaphone-reportinglogs''' to save log files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

===Troubleshooting===

'''Howto save and restore Linux AP data/database if the webgui is not available'''

If the linux ap webgui is not reachable a common reason is that the harddisc is full.
If a full hd is the case, maybe your first thought is to increase the harddisc.
It could be a solution but there are some traps to increase the partition in linux which can be ended in complete data loss

The fastest way to get linux ap working with a new harddsik size is to install a new one.

'''How can you save the data without get access over the webgui?'''
If you can reach linux via putty it could be possible :)

Here are some possibilities how to do that over the shell:
'''(But keep in the back of you head that you are working as root and therefore typing errors can lead to undesirable behaviours!)'''

1. Delete at first all the logfiles. Sometimes a few MByte are enough to get all the stopped services running again and you could reach liunx over the webgui.
i.e. the reporting logfiles are under "''/var/www/innovaphone/apps/innovaphone-reporting/log''", the fax server logfiles are under
"''/var/www/innovaphone/apps/innovaphone-faxserver/log''"
-> '''Don't delete the 'log' directory itself!''' Delete only the content:

root@vmware-debian: cd /var/www/innovaphone/apps/innovaphone-reporting/log/
root@vmware-debian: rm *

Is the linux ap after a restart running and over http reachable, download all the config and databases and restore them on the new linux ap (2.2).

[[image:save.png]]

2. In case the reason for the unreachable webgui was not a full harddisk you can save the config/database (only reporting and exchange connector at the moment)
over the shell.

root@vmware-debian:/# cd /home/postgres/
''for reporting type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-reporting | gzip -fc6 > innovaphone-reporting-db.gz

root@vmware-debian:/# cd /home/postgres/
''for exchange connector type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-exchange | gzip -fc6 > innovaphone-exchange-db.gz

2.1 Access linux with winscp '''(protocol: scp / user: root)''' and download the .gz (don't unzip)

[[image:reporting.png]]

(BTW: you can '''download''' with '''scp''' also the complete webdav files. But for the '''upload''' use as user 'admin' and as protocol "'''webdav'''".
Otherwise the owner is still root and this ends in authorization problems)

[[image:webdav.png]]

2.2. on the new linux ap upload this .gz

[[image:restore.png]]

3. The steps mentoined above should be only the last try to get the data and could work or not.
To be always on the save site use a standby linux (for reporting), save configs (update server) and delete (automatic) old cdr's to avoid a full hd.

==Appendix==
===PostgreSQL Patterns===
For filter conditions or for the pbx object value you can use the following patterns inside a string:

* '''%''': matches any string of zero or more characters
* '''_''': matches any single character

Example:
'''Sat%''' will match all pbx objects, which start with the string '''Sat'''.

We do always perform case insensitiv searches!

===innovaphone Reporting XML===
<code type="xml">
<?xml version="1.0" encoding="utf-8"?>
<application>
<name>innovaphone Reporting</name>
<desc>Reporting software</desc>
<directory>innovaphone-reporting</directory>
<href>report.php</href>
<linux-username>innovaphone-reporting</linux-username>
<packages>
<package>php5-gd</package>
<package>php5-ldap</package>
</packages>
<database name="innovaphone-reporting" username="innovaphone-reporting"/>
<cronjobs>
<cronjob script="/etc/cron.d/reporting_replication"/>
<cronjob script="/etc/cron.d/reporting_cleanup"/>
<cronjob script="/etc/cron.d/reporting_mails"/>
</cronjobs>
<log-files>
<log title="Postgresql-8.4" no-clear="true">/var/log/postgresql/postgresql-8.4-main.log</log>
<log title="Reporting cleanup">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_cleanup.log</log>
<log title="innovaphone Reporting">/var/www/innovaphone/apps/innovaphone-reporting/log/innovaphone-reporting.log</log>
<log title="innovaphone Reporting Replication">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_replication.log</log>
</log-files>
<config-files>
<conf>/etc/postgresql/8.4/main/pg_hba.conf</conf>
<conf>/etc/postgresql/8.4/main/postgresql.conf</conf>
<conf>/home/innovaphone-reporting/reporting.conf</conf>
<conf>/home/root/ssl_cert/server.key</conf>
<conf>/home/root/ssl_cert/server.crt</conf>
<conf>/etc/cron.d/reporting_replication</conf>
<conf>/etc/cron.d/reporting_cleanup</conf>
<conf>/etc/cron.d/reporting_mails</conf>
<conf>/var/www/innovaphone/apps/innovaphone-reporting/report_images</conf>
</config-files>
<backup>
<command title="Save innovaphone Reporting configuration files" cmd="saveinnovaphone-reportingcfgs" script=""/>
<command title="Save innovaphone Reporting database" cmd="saveinnovaphone-reportingdb" script=""/>
<command title="Save innovaphone Reporting log files" cmd="saveinnovaphone-reportinglogs" script=""/>
</backup>
<restore>
<command title="Restore innovaphone Reporting configuration files" cmd="restoreinnovaphone-reportingcfgs" script="">
<action>/etc/init.d/postgresql restart</action>
<action>/etc/init.d/cron restart</action>
</command>
<command title="Restore innovaphone Reporting database" cmd="restoreinnovaphone-reportingdb" script=""/>
</restore>
<uninstall script="/usr/bin/sudo /usr/local/bin/uninstall_script.sh -f 'innovaphone-reporting.xml' -linux_user yes -linux_group yes -database yes -database_user yes -log_script '/var/www/innovaphone/log/appl_uninstall.log'">
<to-delete>
<to-del path="/usr/local/bin/reporting_cleanup.sh"/>
<to-del path="/usr/local/bin/reporting_replication.out"/>
<to-del path="/usr/local/bin/reporting_replication.sh"/>
<to-del path="/home/innovaphone-reporting/tmp"/>
</to-delete>
</uninstall>
<lighttpd-auth>1</lighttpd-auth>
<public-web-paths>
<path>mypbx</path>
<path>user</path>
</public-web-paths>
</code>

===Installed Debian Packages===

The following packages (and their dependencies) are installed with innovaphone Reporting:

* php5-gd
* php5-ldap

===Configuration Files===

pg_hba.conf is the client authentication configuration file and controls which hosts are allowed to connect, how clients
are authenticated, which PostgreSQL user names they can use and which databases they can access.

postgresql.conf is the PostgreSQL configuration file

===Data Files===

If you backup the innovaphone reporting database, you'll get a gz archiv, which contains the whole innovaphone-reporting database.

===Report XML and CSV===
The field description below applies for the '''XML''' and '''CSV''' columns!

<code type="xml">
<report>
<record>
....
<time time="1301303966" utc="1301303966">2011-03-28 11:19:26</time>
<obj>Saturn</obj>
<id>870998fee909d311b2ec009033105dc9</id>
<call>int</call>
<alert-duration seconds="0">0:00</alert-duration>
<flow>
<ev caller="ep1" ep1_number="101" ep1_name="saturn" ep1_dn="Saturn"
ep2_number="102" ep2_name="uranus" ep2_dn="Uranus" status="co" entry="true"/>
</flow>
<call-duration seconds="2">0:02</call-duration>
<billing-duration seconds="2">0:02</billing-duration>
<conn-duration seconds="2">0:02</conn-duration>
<groups>
<group>test</group>
<group>test2</group>
</groups>
<node>root</node>
<pbx>.</pbx>
<cause></cause>
<dir>o</dir>
<status>co</status>
<type/>
<remote number="102" name="uranus" dn="Uranus"/>
<callback number="456" name="abc" dn="123" time="1301305962">2011-03-28 11:52:42</callback>
</record>
....
</report>
</code>

* time: the node contains a formatted time string of the local time
** attribute '''time''' is a unix timestamp (referring to the local time stamp of the CDR)
** attribute '''utc''' is a unix timestamp (referring to the utc time stamp of the CDR)
* obj: the PBX object name (also called cn)
* id: the conference id of the call
* call: '''int''' (internal) or '''ext''' (external) call
* flow '''(XML only)''': the call flow
** ev
***ep1 (ep1_number, ep1_name, ep1_dn): the left side of the call
***ep2 (ep2_number, ep2_name, ep2_dn): the right side of the call
***caller: '''ep1''', '''ep2''' or empty, if unknown
***status: '''co''' (connected), '''al''' (alert), '''er''' (error) or '''bu''' (busy) state of the current event
***entry: '''true''' for the entry event of the local object
***type: '''cf''' (call forward), '''ct''' (call transfer)
* Original Called '''(CSV only)''': In case of Call flow; The original called device
* Diverting '''(CSV only)''': In case of Call flow; The diverting device
* Transferring '''(CSV only)''': In case of Call flow; The transferring device
* groups '''(XML only)''': the groups of the PBX object
* node: the node of the PBX object
* pbx: the pbx of the PBX object
* cause: the decimal disconnect reason of the call (see [[Reference:ISDN_Cause_Codes]])
* remote:
** outgoing calls -> dialed endpoint
** incoming calls -> first ep2 above entry event or entry event if this is the first one
** incoming calls with incoming transfer after entry event -> transfer target
* status:
** outgoing calls -> best found status in call flow
** incoming calls -> status of entry event
* type: the type of the entry event or, if not set, the type of the next event, if given
** empty: direct call
** '''ct''': call transfer
** '''cf''': call forward
** '''cct''': call transfer with consultation
** '''pu''': call pickup
* dir: o (outgoing) if the first event is the entry event and the caller is ep1
* dir: i (incoming) if not o
* alert-duration: alert time
*Billing Duration: the duration, a user must be billed for
** outgoing call -> duration from the first event until the last event in the flow
** incoming call -> duration from the first transfer/forward event until the last event in the flow
* call-duration/Call Duration (Total): duration of the whole call, e.g. with the duration of a subsequent transfer
* conn-duration/Call Duration (User): just the time, the user was connected. Duration from the entry event until the event, where the local endpoint isn't connected any more
* callback: '''name''', '''number''', '''dn''' and '''time''' if this call has been callbacked using mypbx (time referrs to the UTC time of the callback)
* Further Registration: If more than one devices is registered to the same object, each device creates a CDR. This field identifies the additional CDRs for the same call
* Object Info '''(CSV only)''': combination of object names and number
* Date '''(CSV only)''': extracted date only from the time_string
* Time_2 '''(CSV only)''': extracted time only from the time_string

===Database Structure===

====cdrs====
Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDR]])

This section is composed by four tables: cdrs, events, groups and cdr_properties.
The first three tables contain the corresponding fields to store the information contained in the cdr, event and group tags. 
Each CDR represents the call in the view of one PBX object. So there might be multiple CDRs for one call if multiple PBX objects are used within the call.

* '''cdr fields:''' id, guid, sys, pbx, node, device, cn, e164, h323, dir, utc, local.
* '''event fields:''' id, msg, type, e164, h323, conf, cause, time, cdr_id, order_index.
* '''group fields:''' id, name, active, type, cdr_id.

'''id''' field is assigned by postgresql for each entry and has nothing to do with the information present in the cdr. It is different for each entry inside the table.

The events table has two additional fields, called cdr_id, to associate these events to the corresponding cdr entry and order_index to keep their position inside the cdr.
Groups table has also the cdr_id field to associate the group entries to the corresponding cdr and events entries.

The '''cdr_properties''' table contains relevant information associated with the call such as call_length, alert_length or call_flow. It also presents a cdr_id field.

====filters====

This section is composed by three tables: filter_columns, filter_conditions and filters.

* '''filter_columns''' is not used for the time being. This is supposed to contain the columns the user wants to see in his report, but right now, just default columns (Time/Object/Duration/Left/Direction/State/Right) are shown.
* '''filter''' contains the filter name and description plus two conditions call_state (No Response, Connected, Busy and No Channel) and direction (Incoming, Outgoing, Transfer and Call Forward).
* '''filter_conditions''' contains the defined conditions for a filter

All three tables are related through an id.

====cdr_users====

This table contains a timestamp '''missed_calls_time''' for the last report access by a user '''cn''' + ('''pbx''' OR '''sys''') with mypbx. It is used to retrieve information about missed calls since the last use of mypbx. 
The timestamp '''clear_report_time''' indicates the last clearance time. 
email, sys (system name) and pbx (PBX name) are also stored for each user.

====replication====

Contains information of the last replication run, which is used to sync master/standby installations.

===Replication===

The replication between the master and standby servers is divided into two steps:

====CDRs====
Both master and standby server keep an information about the last replicated CDR. From this CDR on, they retrieve all CDR guids (32 bytes) from all new CDRs from the other server. If a guid already exists in the local database, the CDR is skipped, otherwise it is replicated. 
So there is a minimal data exchange for already existing CDRs and each new CDR is only processed once.

====Filters/LDAP/Report Mails/Users====
The master server does nothing here, but the '''standby''' deletes all filters, LDAP servers, report mails and users and replicates all from the master. 
So these items from the master server can be used, but not changed, on the standby server.

===Remote Interface===

You can retrieve the PDF/XML/CSV report with a remote interface. 
Make a POST or GET HTTP request to '''http(s)://Linux-IP/apps/innovaphone-reporting/report.php''' with the following parameters:

* remote: mandatory for a remote request!
** '''1'''
* from : the from date/time as UNIX timestamp '''OR''' date/time string as described [ http://www.php.net/manual/de/datetime.formats.php | here ].
* to: the to date/time (format see '''from''')
* [format]: the return format, allowed values:
** '''xml''': default
** '''pdf'''
** '''csv'''
* [sortby] : the report sorting, allowed values:
** '''time''': default
** '''obj''': sort by pbx object name
** '''call-duration'''
** '''alert-duration'''
** '''dir''': sort by call direction
* [sortorder]: the report sort order, allowed values:
** '''ascending''': default
** '''descending'''
* [groupby]: report grouping
** default empty/not set: no grouping
** '''local_stamp''': group by time
** '''cn''': group by pbx object name
* [hidedigits]: hide the last X digits of external numbers
* pbx: search for this PBX (mandatory!)
* pbxobject: search for this PBX object (you can leave this, if you use filterX)
* filterX: use a filter with its name. You can use multiple filters with filter1=test, filter2=test2...
* [filterinfo]: show the filter information in a created report ("true" or "false")
* [lang]: the language, e.g. "en" or "de"
* [displayedduration]:
** '''call_duration''': default Call Duration (Total)
** '''conn_duration''': Call Duration (User)
** '''billing_duration''': Billing Duration
* [anonym]: anonymize internal names/numbers ("true" or "false")
* [bulk]: creates user reports (see [[ #Report_Mails | Report Mails ]])
* [sender]: sender email adress of the report
* [confid]: query calls of a certain conference ID
** you can omit the following fields, if using confid: '''from''', '''to''', '''pbx''', '''pbxobject''', '''filterX'''

Parameters in [] are optional.

'''pbxobject''' supports [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]].

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&pbxobject=Saturn
Gets all records between 2011-03-29 and 2011-03-30 for the pbx object Saturn.

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&filter1=test&filter2=test2
Gets all records between 2011-03-29 and 2011-03-30 for the filters test and test2.

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

====PGAdmin====

[http://www.pgadmin.org/ PGAdmin] is an administration tool for PostgreSQL databases.

====Putty====

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

===Call list icons===
The direction of the icon arrow depends on the call flow.

* [[Image:reporting_conn.jpg]]: a connected call
* [[Image:reporting_busy.jpg]]: busy destination
* [[Image:reporting_no_res.jpg]]: no response from destination
* [[Image:reporting_error.jpg]]: an error occurred, like "no channel available" during the call setup
* [[Image:reporting_ct.jpg]]: call transfer
* [[Image:reporting_cct.jpg]]: call transfer with consultation
* [[Image:reporting_cf.jpg]]: call forward
* [[Image:Reporting_pickup.jpg]]: call pickup (or SOAP redirect)
* [[Image:reporting_dir.jpg]]: call direction

A small arrow on a call state icon indicates a callback done with mxPBY, e.g.:
* [[Image:reporting_busy_callback.jpg]]

==Known Problems==
===Replication===
====Callback information====
The callback information get lost in the following scenario:
* The callback CDR is already replicated on both master and standby
* Master or standby is down
* A user calls back the CDR from point 1

====Missed calls====
The information for missed calls is not replicated. So the first time, a standby server is used with mypbx, the missed calls information will be wrong. The second time will be correct again.

===CDRs===
If the innovaphone Reporting is not running, for whatever reaseon, the device, which sends CDRs, currently stores up to 300kB CDRs data. So if one CDR has up to 2kB, 150 CDRs can be stored until the innovaphone Reporting should be up again, to avoid data loss.

===Missing values for PBX drop down box===
If your database currently contains no CDRs of one of your PBX systems, you won't be able to select this system as PBX for report creation or report mail configuration!

===Restoring Database with more than 2GB===

When restoring database using the web browser there is a 2GB upload limit, so if our database have a bigger size the upload will fail.

As alternative solution (if there is enough space):

1. Copy the gz database dump to the webdav folder
2. Uncompress this dump: /bin/gzip -cd /var/www/innovaphone/webdav/dump.gz --uncompress > /tmp/db.dump
3. Start the restore: /usr/local/bin/config.sh postgres db-restore /tmp/pg_schema.dump /tmp/db.dump innovaphone-reporting
4. be patient, this might take a while
5. delete /tmp/db.dump, /var/www/innovaphone/webdav/dump.gz and /tmp/pg_schema.dump (automatically created)

===PDF generation for many CDRs may fail===
You may experience a '''Server error 500''' if you generate PDFs with many CDRs. The PDF library which is used to generate the PDFs fails.
Please generate multiple PDFs with a smaller timespan in such a case.

== Related Articles ==

[[Howto:Integration_reporting_and_voice_recording]]

[[Category:Concept|Reporting]]

Reference10:Concept Linux Application Platform

2016-11-18T14:34:16Z

Tle: /* Linux Application Platform (IPxx10 or IPx11 Gateways) */

==Introduction==

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

==Requirements==

There are 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 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

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

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

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

==Installation==

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

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

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


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


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

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

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

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

====VMWare====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Administration==

===General===

====Configure IP====

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

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

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

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

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

====Configure Authenticated URLs====

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

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

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

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

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

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

===Web Server===

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

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

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

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

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

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

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

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

Here you can change the credentials for Web Server access.

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

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

Here you can change the credentials for webdav access.

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

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

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

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

====Configure mutual TLS====

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

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

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

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

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

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

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

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

[[Image:backup_restore.jpg]]

====Command File====

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

The available default commands are:

=====saveinnovaphonecfgs=====

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

=====saveinnovaphonelogs=====

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

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

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

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

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

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

You can use some macros for the backup filename:

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

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

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

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

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

Open this link to restore all available files/data.

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

===Relay Hosts===

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

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

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

===Database===

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

====Password====

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

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

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

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

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

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

===Upload/Update===

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

==Diagnostics==

===Logs===

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

===RPCAP===

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

===Alarm Server===

Configure an innovaphone device as alarm server:

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

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

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

===Status===

View the disk usage.

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

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

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
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

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

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

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

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

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

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

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

Default trace level are "0"

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

===Tools===

====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%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

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

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

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

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

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

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

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

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

[[Category:Concept|Linux Application Platform]]

Reference10:Concept Linux Application Platform

2016-11-18T14:32:59Z

Tle: /* Linux Application Platform (IPxx10 or IPx11 Gateways) */

==Introduction==

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

==Requirements==

There are 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 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

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

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

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

==Installation==

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

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

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


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


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

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

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

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

====VMWare====

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Administration==

===General===

====Configure IP====

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

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

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

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

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

====Configure Authenticated URLs====

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

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

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

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

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

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

===Web Server===

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

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

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

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

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

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

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

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

Here you can change the credentials for Web Server access.

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

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

Here you can change the credentials for webdav access.

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

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

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

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

====Configure mutual TLS====

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

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

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

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

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

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

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

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

[[Image:backup_restore.jpg]]

====Command File====

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

The available default commands are:

=====saveinnovaphonecfgs=====

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

=====saveinnovaphonelogs=====

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

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

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

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

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

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

You can use some macros for the backup filename:

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

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

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

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

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

Open this link to restore all available files/data.

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

===Relay Hosts===

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

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

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

===Database===

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

====Password====

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

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

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

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

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

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

===Upload/Update===

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

==Diagnostics==

===Logs===

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

===RPCAP===

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

===Alarm Server===

Configure an innovaphone device as alarm server:

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

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

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

===Status===

View the disk usage.

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

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

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
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

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

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

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

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

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

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

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

Default trace level are "0"

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

===Tools===

====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%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

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

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

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

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

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

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

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

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

[[Category:Concept|Linux Application Platform]]

Reference12r1:Concept Softwarephone

2016-08-17T14:00:40Z

Tle: /* '''[Tab: „User Configuration"]''' */

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

= General =

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

=System Requirements=
The innovaphone SoftwarePhone requires:
*Windows 7 or later.
*Innovaphone PBX with SoftwarePhones<v> License.

= Installation =

Prior to installing the 10.00 Version of innovaphone SoftwarePhone an eventually installed 9.00 version must be manually deinstalled. From version 10.00 on, subsequent releases can be updated without first deinstalling the older version.
When updating the installation, the previous configuration (if existing) is reused. Otherwise a default configuration is installed.

The following items are installed:

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

Installation Process:

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

Resetting to defaults:

*Resetting to default configuration could be done by copying the config files from the Install Directory to the Roaming Directory.

Unattended Installation of softwarephone for ALLUSERS:

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

= Configuration =

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

Default login is admin/swphone.

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

* User Configuration
This tab is unique in the way that it can only be accessed from the computer SoftwarePhone is running on. Here the typical End User Configurations are set: Audio, USB-headset and process operational parameters.
* Application
The Applicatons run mode and priority can be set and wheter to register with the computers name at the PBX.
* Audio
The desired audio devices can be selected.
* Audio
The Audio –Input, -Output and –Ringing device can be selected.
* USB
To use the USB headsets function buttons here the device and appropriate map are selected.

The default credentials are admin / swphone

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

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

[[Image:user_config.png]]

'''Application Settings Run Mode:'''

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

'''Microphone:'''

The microphone selection.

'''Speaker:'''

The speaker selection

'''Ringer:'''

The Ringing device selection

'''USB Device:'''

The USB headset selction.

'''USB Map:'''

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

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

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

Admin mode Application configuration.

[[Image:swphone_application.jpg]]

Application Run Mode, Application Priority: see „User Configuration“

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

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

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

[[Image:swphone_registration.jpg]]

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

Admin mode Audio configuration. Items see „User Configuration“

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

Admin mode Audio configuration. Items see „User Configuration“

= Rollout =

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

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

[[Image:swphone_url.jpg]]

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

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

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

#reset the automatic configuration update
config add UP1 /url

#reset SoftwarePhone and apply config
reset

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

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

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

= Supported USB headsets =

The following USB headsets are supported for onhook/offhook functionality:

{{FIXME|reason="Needs to be tested"}}

* innovaphone IP 10 (I)
* innovaphone IP 10 (II)
* Handset for Voip (Couple) (ZMM)
* Handset for Voip (Internet) (ZMM)
* Claritel-i750 - vp (generated)
* GN 8120 USB
* Plantronics CS50/CS60-USB Headset
* GN 9350
* GN 9335e USB port
* Jabra A330 device 2
* Jabra BIZ 2400
* Jabra LINK 320 USB
* Jabra LINK 350 USB
* Jabra LINK 360 USB *
* Jabra PRO 9460 (1041)
* Jabra PRO 94(60/70) (1042)
* Jabra GO 6470 (1003)
* Jabra GO 6470 (1004)
* Jabra PRO 930 (930-25-509-101)
* Jabra LINK 350 OC
* Jabra GO 6430 (6430-17-20-201) | Version C
* Jabra SUPREME UC (5078-230-310)
* Plantronics Savi 740
* Sennheiser VoIP USB headset
* Sennheiser DECT
* Sennheiser CEHS-CI 02
* Jabra SPEAK 410 USB Mono
* Jabra SPEAK 410 USB Stereo
* Jabra BIZ 2400 Mono USB
* Jabra BIZ 2400 USB Mono
* Jabra BIZ 2400 USB Mono (2)
* Jabra PRO 9450
* Jabra PRO 9450 (2)
* Jabra BIZ 620 Mono
* Jabra UC Voice 550 Duo(5599-829-209)
* Jabra UC Voice 550 Mono(5593-829-209)
* Jabra LINK 280(280-09)
* Jabra LINK 14201-30 (DHSG-USB Adapter)
* GN Netcom Jabra 2000 USB Duo NC EMEA
* GN2000 Stereo USB
* Plantronics - Voyager PRO UC v2 (USB/bluetooth)
* Plantronics - CALISTO P420 USB
* Plantronics - Voyager PRO UC v2 (USB/bluetooth) (2)
* Plantronics - Blackwire C320 (85619-02)
* Plantronics - Blackwire C720 (87506-02)
* Plantronics - DA45 (USB/Wired)
* Plantronics - Blackwire C620 (USB/Wired)
* Plantronics - C420 (product aa10)
* Plantronics - C420 (product aa14)
* Plantronics - C435 (P.N. 85800-05)
* Plantronics D100 (USB/Bluetooth, Savi W430, W440)

'''*''' - Reported by costumer not working the MAP keys, however was detected by the Softwarephone.

= Special headsets and behaviours =
Depending on the headset, the used firmware of the headset and special settings in the headset configuration - the standard delivered USB-HID-table inside the softphone-package will not always work.

Improvements in the hid-table concerning special headset behaviour will be delivered with new firmware/service release versions of the softwarephone.

As the "standard" hid-table may work for most of the headsets, selection of the improved table has to be done manually according to the description below:

== Activation ==
After start-up of the softwarephone, right click the softwarephone-icon in the event-tray and select "Configuration".

[[Image:Swphone_hid_adaption.png]]

At the USB-map selection, one can select the headset to be used.
In the lowermost field, the table to be used has to be selected.
If the default table does not work, the improved one named <headset>-2 can be selected.

[[Image:Swphone_hid_adaption_map.png]]

Details see below.
== Jabra 930 UC ==

* Problem: Onhook at headset only possible with two clicks.
* Fixed: to one-click-onhook
* Map to select: Jabra PRO 930-2 (930-25-509-101)
* Headset settings: [[Image:jabra930-2_settings.png]]

= Troubleshooting Connectivity Problems =

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

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

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

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

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

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

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

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

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

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

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

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

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

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

where the

<localAddrV4>192.168.178.21</localAddrV4>

and the

<remoteAddrV4>192.168.178.22</remoteAddrV4>

should be your computers and the PBX’s @.

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

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

= How to obtain debug traces of softwarephone using icollect =

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

If the issue it's related to an application crash please enable the "File Trace" flag at "http://localhost:10006/debug.xml" before and restart the softwarephone.

This is necessary when reporting a bug/problem with innovaphone softwarephone v11.

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

=Known Issue=

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

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

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

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

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

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

=== No license obtained from PBX if SIP Protocol it's used===

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

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

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

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

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

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

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

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

Reference12r1:Concept Softwarephone

2016-08-17T13:57:48Z

Tle: /* '''[Tab: „User Configuration"]''' */

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

= General =

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

=System Requirements=
The innovaphone SoftwarePhone requires:
*Windows 7 or later.
*Innovaphone PBX with SoftwarePhones<v> License.

= Installation =

Prior to installing the 10.00 Version of innovaphone SoftwarePhone an eventually installed 9.00 version must be manually deinstalled. From version 10.00 on, subsequent releases can be updated without first deinstalling the older version.
When updating the installation, the previous configuration (if existing) is reused. Otherwise a default configuration is installed.

The following items are installed:

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

Installation Process:

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

Resetting to defaults:

*Resetting to default configuration could be done by copying the config files from the Install Directory to the Roaming Directory.

Unattended Installation of softwarephone for ALLUSERS:

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

= Configuration =

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

Default login is admin/swphone.

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

* User Configuration
This tab is unique in the way that it can only be accessed from the computer SoftwarePhone is running on. Here the typical End User Configurations are set: Audio, USB-headset and process operational parameters.
* Application
The Applicatons run mode and priority can be set and wheter to register with the computers name at the PBX.
* Audio
The desired audio devices can be selected.
* Audio
The Audio –Input, -Output and –Ringing device can be selected.
* USB
To use the USB headsets function buttons here the device and appropriate map are selected.

The default credentials are admin / swphone

== '''[Tab: „User Configuration"]''' ==

This config GUI is unique in the way that it can only be accessed from the computer SoftwarePhone is running on. Here the typical End User Configurations are set: Audio, USB-headset and process operational parameters.

[[Image:user_config.png]]

'''Application Settings Run Mode:'''

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

'''Microphone:'''

The microphone selection.

'''Speaker:'''

The speaker selection

'''Ringer:'''

The Ringing device selection

'''USB Device:'''

The USB headset selction.

'''USB Map:'''

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

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

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

Admin mode Application configuration.

[[Image:swphone_application.jpg]]

Application Run Mode, Application Priority: see „User Configuration“

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

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

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

[[Image:swphone_registration.jpg]]

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

Admin mode Audio configuration. Items see „User Configuration“

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

Admin mode Audio configuration. Items see „User Configuration“

= Rollout =

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

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

[[Image:swphone_url.jpg]]

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

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

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

#reset the automatic configuration update
config add UP1 /url

#reset SoftwarePhone and apply config
reset

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

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

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

= Supported USB headsets =

The following USB headsets are supported for onhook/offhook functionality:

{{FIXME|reason="Needs to be tested"}}

* innovaphone IP 10 (I)
* innovaphone IP 10 (II)
* Handset for Voip (Couple) (ZMM)
* Handset for Voip (Internet) (ZMM)
* Claritel-i750 - vp (generated)
* GN 8120 USB
* Plantronics CS50/CS60-USB Headset
* GN 9350
* GN 9335e USB port
* Jabra A330 device 2
* Jabra BIZ 2400
* Jabra LINK 320 USB
* Jabra LINK 350 USB
* Jabra LINK 360 USB *
* Jabra PRO 9460 (1041)
* Jabra PRO 94(60/70) (1042)
* Jabra GO 6470 (1003)
* Jabra GO 6470 (1004)
* Jabra PRO 930 (930-25-509-101)
* Jabra LINK 350 OC
* Jabra GO 6430 (6430-17-20-201) | Version C
* Jabra SUPREME UC (5078-230-310)
* Plantronics Savi 740
* Sennheiser VoIP USB headset
* Sennheiser DECT
* Sennheiser CEHS-CI 02
* Jabra SPEAK 410 USB Mono
* Jabra SPEAK 410 USB Stereo
* Jabra BIZ 2400 Mono USB
* Jabra BIZ 2400 USB Mono
* Jabra BIZ 2400 USB Mono (2)
* Jabra PRO 9450
* Jabra PRO 9450 (2)
* Jabra BIZ 620 Mono
* Jabra UC Voice 550 Duo(5599-829-209)
* Jabra UC Voice 550 Mono(5593-829-209)
* Jabra LINK 280(280-09)
* Jabra LINK 14201-30 (DHSG-USB Adapter)
* GN Netcom Jabra 2000 USB Duo NC EMEA
* GN2000 Stereo USB
* Plantronics - Voyager PRO UC v2 (USB/bluetooth)
* Plantronics - CALISTO P420 USB
* Plantronics - Voyager PRO UC v2 (USB/bluetooth) (2)
* Plantronics - Blackwire C320 (85619-02)
* Plantronics - Blackwire C720 (87506-02)
* Plantronics - DA45 (USB/Wired)
* Plantronics - Blackwire C620 (USB/Wired)
* Plantronics - C420 (product aa10)
* Plantronics - C420 (product aa14)
* Plantronics - C435 (P.N. 85800-05)
* Plantronics D100 (USB/Bluetooth, Savi W430, W440)

'''*''' - Reported by costumer not working the MAP keys, however was detected by the Softwarephone.

= Special headsets and behaviours =
Depending on the headset, the used firmware of the headset and special settings in the headset configuration - the standard delivered USB-HID-table inside the softphone-package will not always work.

Improvements in the hid-table concerning special headset behaviour will be delivered with new firmware/service release versions of the softwarephone.

As the "standard" hid-table may work for most of the headsets, selection of the improved table has to be done manually according to the description below:

== Activation ==
After start-up of the softwarephone, right click the softwarephone-icon in the event-tray and select "Configuration".

[[Image:Swphone_hid_adaption.png]]

At the USB-map selection, one can select the headset to be used.
In the lowermost field, the table to be used has to be selected.
If the default table does not work, the improved one named <headset>-2 can be selected.

[[Image:Swphone_hid_adaption_map.png]]

Details see below.
== Jabra 930 UC ==

* Problem: Onhook at headset only possible with two clicks.
* Fixed: to one-click-onhook
* Map to select: Jabra PRO 930-2 (930-25-509-101)
* Headset settings: [[Image:jabra930-2_settings.png]]

= Troubleshooting Connectivity Problems =

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

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

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

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

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

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

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

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

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

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

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

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

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

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

where the

<localAddrV4>192.168.178.21</localAddrV4>

and the

<remoteAddrV4>192.168.178.22</remoteAddrV4>

should be your computers and the PBX’s @.

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

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

= How to obtain debug traces of softwarephone using icollect =

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

If the issue it's related to an application crash please enable the "File Trace" flag at "http://localhost:10006/debug.xml" before and restart the softwarephone.

This is necessary when reporting a bug/problem with innovaphone softwarephone v11.

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

=Known Issue=

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

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

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

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

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

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

=== No license obtained from PBX if SIP Protocol it's used===

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

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

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

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

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

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

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

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

File:User config.png

2016-08-17T13:50:15Z

Tle:

Howto:How to implement large PBXs

2016-07-12T14:22:11Z

Tle: /* Technical data and recommended number of users supported */

innovaphone PBX installations scale from very few users (such as with an IP202) to several thousand users. Here is how to design and configure innovaphone devices to support many users.

==Applies To==
This information applies to

* All innovaphone PBX platforms

build 05-5842 and later.



==More Information==

===Technical issues to be considered===
There are a few issues to be considered when configuring a large PBX:

* CPU power
The platform must be able to cope with all processing requirements to serve the user base. The basic requirement is to support the number of calls created. The ability of a given platform can be measured as its “business hour call attempts” capability, a figure which essentially indicates the number of calls per hour the platform can handle.

Naturally, not only calls take CPU cycles. Major scenarios to consider here include user registration, replication and SOAP/CTI applications (such as TAPI)

* Main Memory
The platform must feature enough main memory to serve the user and call scenarios. Rough “memory/feature” figures will be given.

* Flash Memory
There must be enough persistent memory to store the system configuration. Although the amount of memory used largely depends on the details of the configuration, a rule-of-thumb can be given for the “memory/user” ratio.

* Configuration

The configuration must be appropriate to the intended usage scenario. Guidelines are given for various scenarios.

* Number of channels
Naturally, the number of gateway channels (e.g. to the ISDN or to the DECT network) must be appropriate. The number is a function of the so-called “erlang” value. This issue will not be discussed here.

The information presented in this article is based on practical verification by means of a sample configuration. The setup is made up of 6000 user entries, 10 location entries, 500 speed dial entries and a number of other entries such as trunks etc.

The configuration is attached for your reference.

<center>[[Image:How to implement large PBXs01.jpg|frame|none|The standard Testsetup User]]</center>

<center>[[Image:How_to_implement_large_PBXs02.jpg‎|frame|none|The standard Testsetup User (Details)]]</center>

All measurements given in the remainder of this article apply to the IP800. Since the IP800 both in terms of processor architecture and processing power is comparable to the IP3000, the results apply to the IP3000 too.

Theoretical up to 10000 User PBX can be implemented with multiple IP6000:

<center>[[Image:How to implement large PBXs03.jpg]]</center>

Likewise, up to 15.000 users can be set up with multiple IPxx10.

===Technical data and recommended number of users supported===

The following table shows techncial data and differences between various hardware devices. It also includes figures for the maximum number of “users” supported by the various innovaphone PBX platforms under cetain conditions (i.e. when running the box solely as an LDAP master). These figures are intended as a rough estimate “rule of thumb” guideline.

Please note that these are ''respective maximum'' figures. That is, more than this will not work. However, each role used in a box (e.g. ''LDAP db'', ''Registration PBX'', ''Media gateway'', ...) consumes resources and the figures below are estimates of the expected possible maximum. '''If you run multiple roles on a single device, you may run out of resources before'''.

{| {{table}}
| align="center" style="background:#f0f0f0;"|'''Product'''
| align="center" style="background:#f0f0f0;"|'''CPU (Mhz)'''
| align="center" style="background:#f0f0f0;"|'''RAM (GB)'''
| align="center" style="background:#f0f0f0;"|'''FLASH (MB)'''
| align="center" style="background:#f0f0f0;"|'''NAND (GB)'''
| align="center" style="background:#f0f0f0;"|'''LAP'''
| align="center" style="background:#f0f0f0;"|'''RAM for LAP (GB) out of RAM'''
| align="center" style="background:#f0f0f0;"|'''DSP'''
| align="center" style="background:#f0f0f0;"|'''CONF'''
| align="center" style="background:#f0f0f0;"|'''Fax Ch'''
| align="center" style="background:#f0f0f0;"|'''Audio Fax Ch out of Fax Ch'''
| align="center" style="background:#f0f0f0;"|'''G711'''
| align="center" style="background:#f0f0f0;"|'''G723'''
| align="center" style="background:#f0f0f0;"|'''G729'''
| align="center" style="background:#f0f0f0;"|'''G722'''
| align="center" style="background:#f0f0f0;"|'''OPUS'''
| align="center" style="background:#f0f0f0;"|'''ETH'''
| align="center" style="background:#f0f0f0;"|'''loop in'''
| align="center" style="background:#f0f0f0;"|'''PRI'''
| align="center" style="background:#f0f0f0;"|'''BRI'''
| align="center" style="background:#f0f0f0;"|'''BRI inline power'''
| align="center" style="background:#f0f0f0;"|'''FXO'''
| align="center" style="background:#f0f0f0;"|'''FXS'''
| align="center" style="background:#f0f0f0;"|'''SSD'''
| align="center" style="background:#f0f0f0;"|'''CF'''
| align="center" style="background:#f0f0f0;"|'''Recommended maximum number of myPBX clients when using full encryption'''
| align="center" style="background:#f0f0f0;"|'''PBX User (all-in-one)'''
|-
| IP311||400||1||32||0,128||x||0,768||6||-||1||1||x||x||x||-||x||2*1000||-||-||-||-||4||2||x||-||75||50
|-
| IP411||400||1||32||0,128||x||0,768||6||-||1||1||x||x||x||-||x||2*1000||-||-||2||-||-||2||x||-||75||50
|-
| IP811||800||2||32||1||x||1,536||10||10||2||2||x||x||x||-||x||2*1000||x||-||5||-||-||-||x||-||750||200
|-
| IP3011||800||2||32||1||x||1,536||30||30||7||7||x||x||x||-||x||2*1000||-||1||-||-||-||-||x||-||750||500
|-
| IP0011||800||2||32||1||x||1,536||0||-||7||0||-||-||-||-||-||2*1000||-||-||-||-||-||-||x||-||750||500
|-
| IP1130||800||0,25||32||-||-||-||30||30||7||7||x||x||x||-||x||2*1000||-||1||-||-||-||-||-||-||n.a.||-
|-
| IP29||400||0,25||32||-||-||-||8||-||-||-||x||x||x||-||x||1*100||-||-||-||-||-||8||-||-||n.a.||-
|-
| IP28||125||0,032||16||-||-||-||8||||-||-||x||x||x||-||-||1*100||-||-||-||-||-||8||-||-||n.a.||-
|-
| IP38||125||0,032||16||-||-||-||8||-||1||0||x||-||x||-||-||1*100||-||-||-||-||8||-||-||-||10||10
|-
| IP302||125||0,032||8||-||-||-||4||-||1||1||x||x||x||-||-||2*100||-||-||1||-||-||2||-||x||10||10
|-
| IP305||125||0,032||8||-||-||-||4||4||1||1||x||x||x||-||-||2*100||-||-||1||-||-||2||-||x||10||10
|-
| IP800||125||0,032||8||-||-||-||10||10||2||2||x||x||x||-||-||2*100||x||-||5||x||-||-||-||x||40||40
|-
| IP810||800||0,5||32||-||x||0,384||20||20||10||10||x||x||x||-||-||2*100||x||-||5||x||-||-||-||x||200||200
|-
| IP0010||800||0,5||32||-||x||0,256||60||60||10||10||x||x||x||-||-||2*100||-||-||-||-||-||-||-||x||650||500
|-
| IP3010||800||0,5||32||-||x||0,256||42||42||10||10||x||x||x||-||-||2*100||-||1||1||-||-||-||-||x||650||500
|-
| IP6010||800||0,5||32||-||x||0,256||60||60||10||10||x||x||x||-||-||2*100||x||4||1||-||-||-||-||x||650||500
|-
| IP1060||800||0,5||16||-||x||-||60||60||60||30||x||-||-||-||-||2*100||-||2||1||-||-||-||-||x||-||-
|-
| IP22||125||0,032||16||-||-||-||2||-||-||-||x||x||x||-||-||1*100||-||-||-||-||-||2||-||-||-||-
|-
| IP24||125||0,032||16||-||-||-||4||-||-||-||x||x||x||-||-||1*100||-||-||-||-||-||4||-||-||-||-
|-
| IP6000||533||128||16||-||-||-||60||60||10||10||x||x||x||-||-||2*100||x||4||1||-||-||-||-||x||500||n.a.
|-
| IP3000||133||n.a.||n.a.||-||-||-||30||-||-||-||x||x||x||-||-||2*100||-||2||1||-||-||-||-||x||n.a.||n.a.
|-
| IP2000||533||128||16||-||-||-||20||0||0||0||x||x||x||-||-||2*100||-||1||1||-||-||-||-||||500||n.a.
|-
| IPVA||||||||||||||0||-||7||0||colspan="16"| For a calculation of IPVA ressources, see [[Howto:A rough estimate of IPVA Performance]]
|-
|
|}


The ''Recommended maximum number of myPBX clients when using full encryption'' refers to a setup, where all communication (including signalling) is encrypted.

The ''PBX User (all-in-one)'' refers to a setup including all functionality such as UC



The ''recommended'' figures are pretty conservative, so as to make sure that a configuration obeying the figures will work well under normal circumstances. However, in certain usage situations, such as use of broadcast groups or waiting queues, missing CPU cycles could result in slow service.

All figures are related to a single platform (that is, innovaphone box). Larger installations can be designed using several boxes running related PBXs. See below for details.

From version 8 upwards, the maximum amount of flash memory allocatable for the directory (FLASHDIR0) is limited to a platform specific reasonable value by default. It can be raised using the

<code>mod cmd FLASHDIR0 /seg n</code>

command, where ''n'' is the number of allowed 64kB segments.

Figures for the IPVA platform obviously depend on the machine used. See [[Howto:A rough estimate of IPVA Performance]] for an estimate.

Please note that these figures ''do not apply to applications on the Linux Application Platform''. More specifically, the figures in the ''Recommended maximum number of myPBX clients'' column do not suggest that a LAP running on such a device can serve the same number of users with all applications such as fax, calendar replication, call lists, reporting. It is extremely difficult to estimate the number of users that can be served on a LAP of a given platform, as it again heavily depends on the applications and usage patterns. However, as a rule of thumb, a LAP running on an xx10 platform should be able to support 150 users with average usage patterns. When more users have to be supported, we strongly recommend to consider a LAP running on VMware. For comparison to a VMware platform, keep in mind that the xx10's ARM processor is a RISC platform, whereas VMware runs on a CISC platform. You should plan for more RAM on a VMWare platform thus. This might lead to the following calculation: if you look at supporting 300 users on a LAP, use VMWare and dedicate at least 1.6GHz CPU and 1 GB RAM (please note that the ''RAM'' column in the table above shows the total RAM available in the system which is shared by the PBX and the Linux-OS). The total RAM available for the LAP is shown on the LAP's ''Diagnostics/Status'' page).

==== Load Calculator ====
We have a nice [http://www.innovaphone.com/de/partnerarea/partner-tools/load-calculator.html online tool] available to partners which allows you to calculate the expected load given a specific usage scenario.

=== Flash Memory ===
Flash memory is mainly used to store object definitions in the LDAP database. So the number of defined objects is calculated as a function of the flash memory used to define the objects.

The actual space used by an object definition heavily depends on the number and size of attributes set for the object since the objects are stored “packed” in flash memory. For example, users with long names will consume more space than those with short names. Also, users with a defined call forwarding will consume more space. Because of this, in a given scenario, the number of objects that can be stored in the platforms available flash memory can vary considerably. However, since in normal operation, object definitions are changed frequently, you need to calculate a rather large amount of memory per entry. We recommend to plan for 512 bytes per object entry. This should be sufficient even for unusual complicated configurations. In a given installation, it is well possible that a platform supports significantly more defined objects than indicated in the table above.

Please note that the number of defined objects is not identical to the number of users supported. This is because there are usually a lot of non-user objects defined. As an example, speed dial entries will count into the total number of defined objects. The actual ratio of supported users to defined objects obviously is depending on the installation at hand. Still, as a rule of thumb, you should calculate at least 33% more defined objects than supported users. That is, if you intend to support 1000 users, you may want to calculate for 1400 defined objects.

Also, you need to be aware that the LDAP database needs to keep track of deleted items for replication purposes. Such items are kept for a while in flash memory (although they are not seen in the user interface any more). The amount of memory required to store such items obviously depends on the deletion rate of objects. Especially when using automated tools to delete and create a large number of objects, you may create a lot of “deleted” items which consume flash space. For this reason, when you create a new object database in a PBX which already had a significant number of objects before, make sure first to do a “clear PBX config”. This will physically clear the LDAP database whereas any other method (including ad-hoc replication from a master PBX database) will create a deleted object for each previously existing object.

You can query the current flash memory usage with

'''mod cmd FLASHMAN0 info'''

For more information about flash directory sizing, see [[Concept Flash Directory]].

=== Main Memory ===
Main memory is obviously required for any kind of operation in the PBX. However, there are some prominent situations which require sufficiant memory. These include amongst others

*System boot

Depending on the firmware size (the firmware is store compressed in flash and thus will be uncompressed into main memory at boot time) and the basic configuration, there is an initial main memory requirement of slightly less than 3MB currently.

During boot, all objects are retrieved from the LDAP database and shadowed in main memory. This will take significantly more space than it consumes in flash memory. The exact amount again depends on the specific object configuration. As a rule of thumb, you can expect 2.7kB per object (based on the same configuration complexity assumed above for flash memory usage). However, during boot time, there is an additional need for main memory of slightly less than twice the flash memory used. We recommend to calculate for approximately 3.5kB per user main memory thus.

*Endpoint Registration

When an endpoint is registered with the Gatekeeper (PBX), it will consume an additional 1.6kB main memory.

*CDR delivery

CDRs to be delivered via HTTP are buffered if delivery cannot take place immediately. The buffer space reserved is 300kB. Since there are 2 CDR interfaces and the LOG interface is treated identically, 900kB must be calculated for buffering.

*Call signaling

Concurrent call signaling will consume further main memory. The exact amount of memory obviously vastly depends on the exact nature of the calls (e.g. internal calls, calls to local interfaces, broadcast calls, etc.). We have measured a test setup where 100 registered clients constantly setup and tear down calls so that there is an average of 15 calls at a time. All calls were monitored by a SOAP application (such as TAPI).

This creates a memory load of an additional 700kB.

Please note that this is a heavy duty load scenario since long lasting calls will consume much less memory load.

You can query the current memory usage with

'''mem'''

===CPU===
The overall performance of a PBX can be measured and given as ''busy hour call attempts (BHCA)'' figure. We have measured 2 scenarios:

*Pure gatekeeper mode

This is the same scenario as in the “Main memory / Call Signaling” section above. 100 clients are registered with the PBX and constantly setup and tear down calls so that there is an average of 15 calls at a time. Both ends of all calls terminate in an IP endpoint, so external call signaling issues such as those induced by an ISDN interface are not considered. No SOAP monitoring.

The IP800 performed with 4.57 calls per second with a CPU load of 30%. This amounts to 15 calls per second with a 100% CPU load and thus approximately 50.000 BHCA.

*Combined gatekeeper and gateway mode

Same scenario as above except that additionally all ISDN interfaces are busy with calls from IP to ISDN with a 60ms packet size. This base load creates 6% CPU load.

The IP800 performed with 45.000 BHCA in this scenario.

The IP3000, having approximately the same CPU power, has more ISDN channels to drive when in gateway mode (30 instead of 8). The respective figures for the IP3000 do differ thus. The base load (all 30 channels active with 60ms packets) is 21%. The IP3000 performs with little better than 40.000 BHCA in this scenario.

For both platforms, the base load increases significantly if the packet size is reduced. For example, the IP3000’s base load increases to 42% when 30 20ms channels are active. It is thus recommended to avoid small packet sizes.

An IP800 with 6500 defined objects will take about 20 seconds to boot.

You can query the current CPU load with

'''mod'''

To reset the CPU tick counter, use

'''mod clr'''

===LDAP performance===
LDAP is used both for replication of PBX and DECT gateway configurations and for name and number resolution in the IP200.

Using current firmware, there are no performance issues with the LDAP replication.

LDAP name and number resolution performance largely depends on the number of entries defined in the PBX/LDAP database. Based on a setup with 1000 user and 500 speed dial entries configured, the IP800 performs with a maximum of 16 LDAP connect/query/result/disconnect cycles per second.

Assumed that there is one such cycle per call, this will effectively cut down the BHCA to 50%.

It is recommended to use an external LDAP server such as MetaDirectory for large (> 1000 users) PBXs thus.

The number of concurrent LDAP sessions is limited to 30 in a standard configuration. When a new session is requested, older idle sessions will be terminated. However, replication sessions are never terminated so this may result in the ability to create a new session requested. The IP200’s LDAP client will terminate its query session after 3 seconds, however with many phones, the PBX may run out of LDAP sessions. You may want to increase the number of sessions using the

'''config change LDAPSRV0 /max_session ''n'' '''

config file option (with 300 being the maximum for ''n'').

===Small PBX===
For smaller PBXs (1000 users and less), a single IP800 or IP3000 can serve as a platform. If redundancy is desired, one platform can be used as master PBX, the other can be used as gateway and standby PBX (so as to distribute gateway and gatekeeper load, especially for the IP3000).

===Medium PBX===
If the PBX has to support more users, then we recommend to use one IP800/IP3000 per 1000 PBX users. If a uniform numbering scheme is desired and all users shall be maintained in a single PBX, we recommend to add an IP800 which will then hold the complete PBX/LDAP database. This will be the “master PBX” and all other platforms will be defined as “slave location” and register with the master PBX. Their configuration will be replicated from the master PBX, restricted to their specific location data. This is because both hosting the complete configuration and serving a large number of registrations at the same time will decrease performance. The actual endpoint registrations will be only on the slave locations so that each platform needs to handle no more than 1000 registrations at a time.

Each endpoint will register with its defined location PBX. You can freely assign endpoints to locations at will, provided the number of endpoints per location does not exceed 1000.

The master PBX should be used as standby PBX for all locations, so that if a single location PBX fails, the master PBX will take over the 1000 registrations.

While the endpoints register with their location PBX, the IP200s LDAP connection should be configured such that the central master location PBX is used as LDAP server. This is to make sure all IP200 will see the complete phone book. As discussed above, you may want to consider an external LDAP server in which case this should be configured as LDAP connection.

Up to 6000 users can be supported this way.

===Large PBX===
If a uniform numbering plan and centralized administration is not an issue, large PBXs can be design virtually without limits.

A tree of PBX locations would be configured, each of them storing its own endpoints and/or sub-locations. Each single location can support up to 1000 endpoints.

Since there is no single instance that knows all of the endpoints, the locations must be defined using the “prefix” mode so that calls can be routed according to the called number by traversing the location tree towards the leafs.

All endpoints must register with the correct PBX as defined by the extension prefix-chain down from the root/master location PBX.

===Replication===
As noted above, when replicating a larger location PBX from a master PBX, the location PBX’s replication settings must restrict the data to be replicated to their own location.

Especially when a location I using a smaller platform such as an IP202 or IP400, this configuration is critical in order not to overflow the locations LDAP capacity.

The same applies to the DECT gateways IP600 and IP1500. They will normally replicate all users, not just the DECT users. However, usually not all the location users are DECT users too and the number of location users may not fit into the number LDAP database of the DECT gateway. You can restrict the objects replicated to the real DECT users using a special configuration of the DECT gateways LDAP replication client. Assumed the DECT users are configured such that the “DECT-GW” is set to “dect” in the PBXs user entries. You would then configure the “Location” in the “LDAP Replication” settings of the DECT gateway to

'''(pbx=<gw *name=”dect”*>)'''

This configuration is taking advantage of the fact that a location search attribute starting with a ‘(‘ is considered a complete LDAP search expression. The “DECT Gateway” section of a PBXs user configuration is stored in an LDAP attribute such as

'''pbx=<gw name="dect" dsp="user" ipei="12345"/>'''

===Known Problems===
PBX Groups are PBX-local objects. Users registered on different PBXs/locations belonging to groups with the same name are this effectively members of different groups. The other way round, in a single group there cannot be members registered with different PBXs/locations. If you need to add a PBX user to a remote PBX, you will need to create a co-registration on that PBX and add this registration user to the group.

Since V11r2 see also [[Reference11r2:Concept_Group_Pickup_across_PBXs]]

The TAPI service provider currently maintains a single connection to a single PBX. It will thus not be able to monitor users on more than one PBX/location. ([[User:Ckl|ckl]] 12:22, 11 January 2011 (CET) this changed with TAPI V7)

{{FIXME|reason="This article urgently needs a V6,7,8,9,10 rewrite"}}

== Relevance for V6 Firmware and later ==
Most of the conclusions presented in this article still hold true for V6 and V7 firmware. You should just calculate slightly less available memory for the devices as the firmware grows and thus leaves less memory for operation. Also, when looking at the IP2000/6000 you need to know that it has 4 times more memory than the IP800 and is 4 times faster than the IP800.

==Relevance for V7 and later==

A IP2000/IP6000 can handle up to 10.000 Objects.

Group limitation is up to 2048 Objects in a group.

IP30x is slightly faster than an IP800, but has considerably less memory. Watch out, the relevant memory (DRAM) space is after system startup, not what is physically available. Especially for the IP30x, a lot of memory is consumed for the DMA interface to the DSP processor. Here is a sample out <code>!mem</code> output directly after a IP302 system startup:

<pre>
physcial memory: 16777216
allocated: 561916
total malloc space: 4590600
free for malloc: 3019008
Total memory usage: 1504584
Memory Load: 32%
</pre>
Allocatable memory is only 2948kB (3019008)!

<code>config change LDAPSRV0 /max_session n</code> is not supported any more (nor is it necessary).

==Relevance for V8 and later==

<code>mod cmd FLASHDIR0 /max nitems</code> is not supported anymore (nor is it needed).

== Related Articles ==

* [[Reference:Device Health Check]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

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

Reference:IP1202/IP1203 DECT System

2016-06-28T10:28:59Z

Tle: /* Bluetooth Headset Support for IP63 */

This article describes the new IP1202 DECT system, differences to the IP1200, the migration policy and provides further helpful information.

==Applies To==
This information applies to:

*IP1202
*IP1202e
*IP61
*IP63

It touches:

*IP1200
*IP52
*IP54
*IP55
*IP56
*IP64

==Product Availability==

===IP-DECT base stations===

The '''IP1202''' (50-01202-001) is ready for order since April 2012.

The '''IP1202e''' (50-01202-003) with two external antenna connectors and two included dipole omni directional antennas will be ready for order in Q4/2012.

The '''IP1200''' can be ordered until supplies run out.

The '''defective IP1200''' devices can be repaired via RMA process until 05/2014.

===IP-DECT Repeater and Antennas===

The IP-DECT Repeater '''for IP1200''' and External Antennas can be ordered until 05/2014.

'''IP1202e''' includes two dipole omni directional antennas. Directional antennas have to be ordered separately depending on the use case. Following models will be available for order soon:
* DualDirectionalAntenna (50-01202-004)
* DirectionalSingleAntenna (50-01202-005)
* OmniDirectionalSingleAntenna (50-01202-006)

===DECT Handsets and Accessories===

The DECT handsets '''IP61''' (50-00061-001) and '''IP63''' (50-00063-001) are ready for order since April 2012.

The DECT handsets '''IP52, IP54, IP64, IP55, IP56''' can be ordered until 05/2014 ([http://www.innovaphone.com/en/press/newsletter/news-2014-05.html not available anymore]).

For the new DECT handsets IP61 and IP63 following chargers are available:
* simple charger (50-00060-002)
* programming charger (50-00060-003)(DC4-AAAB/3B) for administration purposes (via WinPDM, no Firmware Update for the charger itself is required)
Please be aware of the fact that chargers have to be ordered separately and are not part of the handset!

==Compatibility Statements==

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

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

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

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

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

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

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

=== Mixed Ascom/innovaphone Environments ===
It is generally not supported to mix Ascom and innovaphone DECT products in a single installation, e.g.

* Combination of IP1202/IP1202e and Ascom IPBS2 base stations is neither allowed nor supported
* Usage of IP61/IP63 with Ascom IPBS2 based networks is not supported
* Usage of non-innovaphone handsets in IP1202 based networks is not supported
* Usage of IP61/IP63 with Ascom Alarm/Messaging Server (ex:UNITE) is not supported

The one and only exception to this is use of the Ascom d81 which may be operated in an IP1202 environment.

===No Multicell License Required===

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

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

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

===Repeater and External Antennas===

There are '''no DECT repeaters available with IP1202''' based IP-DECT solution. Only IP1202-based base stations must be used.

The DECT repeaters for IP1200 are '''not compatible''' to IP1202/IP1202e.

The '''IP1202''' has no possibility to connect external antennas.

In case external antennas are required, the '''IP1202e''' has to be used. The IP1202e has '''no internal''' antennas.

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

===Bluetooth Headset Support for IP63===

The IP63 DECT handset supports handsfree and headset profiles for Bluetooth.

Following headsets are tested by the manufacturer:

*3M Peltor WS XP
*Jabra EVOLVE 65
*Jabra MOTION
*Jabra STEALTH
*Jabra SUPREME
*Plantronics BlackBeat GO 2
*Plantronics Blackwire 710
*Plantronics M70
*Plantronics M90
*Plantronics ML20
*Plantronics Voyager Edge
*Plantronics Voyager Legend (audio not working correct on outgoing calls with various CTI clients)

==Training==

===DECT Training Kit===

To be able to attempt to the optional DECT Training Topic in the Advanced Training a DECT Training Kit must be ordered.

The DECT Training Kit contains:
*IP1202 x 2
*IP61
*IP63
*Charger for IP61/IP62/IP63
*USB-Programming Charger for IP61/IP63

This kit is referred to as ''Trainingspaket 2 (DECT)'' or ''Training Pack 2 (DECT)'' in the price list. Pleas note that this kit needs to present ''in addition'' to the regular training kit.

===Parallel usage of IP1200 and IP1202 IP-DECT systems===

The operation is only possible as two independent systems. No handover or roaming between the systems is possible. An IP1202-based system can and should synchronize the TDM clock with IP1200 based system to avoid interference.

==Migration Policy For New Projects==

The information in this chapter is only a suggestion which devices to use while plan new DECT projects. No mixing of old and new handsets or base stations is possible in the same project.

===Handsets===

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ DECT Handset Features Matrix
! DECT Handset !! [http://en.wikipedia.org/wiki/IP_Code IP Code]/[http://de.wikipedia.org/wiki/Schutzart Schutzart] !! Headset Connector !! Bluetooth !! Color Display !! Suggested Replacement
|-
| innovaphone IP52 || - || - || - || - || innovaphone IP61, IP63
|-
| innovaphone IP54 || IP54 Dust protected, Splashing water protected || YES || - || - || innovaphone IP63
|-
| innovaphone IP64 || IP64 Dust tight, Splashing water protected || YES || - || - || Ascom d81 Ex
|-
| innovaphone IP55 || - || YES || - || YES || innovaphone IP61, IP63
|-
| innovaphone IP56 || - || - || YES || YES || innovaphone IP63
|-
| innovaphone IP61 || IP40 Object size >1 mm protected || YES || - || - ||
|-
| innovaphone IP63 || IP44 Object size >1 mm protected, Splashing water protected || YES || YES || YES ||
|-
|Ascom d81 (1) || IP65 Dust tight, Water jets protected || YES || YES || YES ||
|-
|Ascom d81 Ex (1) || IP65 Dust tight, Water jets protected || YES || YES || YES ||
|}

Remark (1) - see below

====d81====
When operated within an IP1202 or IP1202e based environment, telephony features of d81 and d81ex are equal to the ones of the IP63.

Ascom-special telephony features as mentioned in the Ascom-d81-family-datasheet are not applicable in this use case.

Features such as man-down-alarm can be realized by upgrading the phone with a special Ascom license, documented [[Reference:d81 Protector|here]].

===Base Stations and Repeaters===

The IP1200 Base Stations and all kinds of DECT Repeaters for IP1200 are replaced by IP1202, cause no repeaters are available for the IP1202 based IP-DECT solution.

==DECT System Feature Comparison==
This chapter describes the differences in the feature sets between old and new DECT systems.

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ DECT Handset Features Matrix
! Feature !! IP1200 based DECT system !! IP1202 based DECT system !! Description
|-
| Registration on 3rd Party IP PBX || YES || NO || IP1202 can only register on innovaphone PBX
|-
| Messaging || [[Howto:Legacy_Method_to_do_DECT_messaging_with_IP1500%2C_IP1200_and_IP600|YES]] || NO ||
|-
| Repeater || YES || NO ||
|-
| External Antennas || YES (on repeater) || YES || with IP1202e
|-
| Non-EU DECT Frequencies || YES || NO || Required for North America, Brazil
|-
| Number of Speech Channels per Radio || 10 || 8 ||
|-
| Max. Number of Radios || 255 || 1000000 || with multiple Mobility Masters for IP1202
|-
| Max. Number of Subscribed Handsets || 1500 || 1000000 || with multiple Mobility Masters for IP1202
|-
| Sync Master Redundancy || NO || YES ||
|-
| Distributed PBX Support with Roaming || NO || YES || In a Master Slave PBX scenario it is possible for DECT Handsets to roam between sites
|-
| Automatic DECT Sync Configuration ||NO || YES || Compared to IP1200 DECT sync, IP1202 is more reliable and stable
|-
| GAP Compatibility || YES || YES || Although both systems are GAP compliant, innovaphone does only support innovaphone handsets used either with IP1200 or IP1202
|-
| CAP Compatibility || NO || YES || IP61/IP63 handsets will always do "external handover" as per CAP (DECT external handover CAP-N.1) between IP1202. GAP-only-compliant handsets will thus not work
|-
| DECT Encryption || NO || YES || DECT Voice Traffic is encrypted between IP1202 and IP61/IP63
|-
| Run innovaphone PBX || YES || NO || On new IP1202 you could not run as innovaphone Master or Slave PBX.
|-
| DECT Security || NO || YES, step B is in preparation || Step B is expected to be published during Q2 2012, see also [http://www.dect.org DECT Forum]
|}

== Usage in non-EU countries ==
The IP1202, IP1202e, IP61 and IP63 can technically be operated in most countries of the world, as the hardware supports all relevant DECT frequencies (software configurable). However, the devices are approved in EU/EFTA states only! Use in other countries will probably be illegal thus.

== Test-SARI ==

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

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

31100422072149

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

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

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

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

==DECT Service Codes==

===IP61===
*#34# - Displays the Device Info
*#06# - Displays the IPEI/IPDI

===IP63===
*#34# - Displays the Device Info
*#06# - Displays the IPEI/IPDI
*#77# - Site Survey Tool

==Admin Menu==

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

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

==Known Problems==
=== Blind Transfer ===
Internal ring tone after external call is blind-transferred to C, which does not save external
number in call list (per IPBS design)
=== Firmware Compatibility ===
Newer IP1202 hardware (such with product code ''IPBS2-M3A '', ''IPBS2-M4A '' or ''IPBS2-M5A'' on the back, introduced 2Q2015) need at least firmware V11r1 SR3 or V10 SR22. Older versions are not supported!

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

Reference11r2:PBX/Objects/Gateway

2016-01-27T14:46:48Z

Tle: /* Gateway Object specific Configuration */

The ''Gateway'' PBX object is used to register a gateway with the PBX. A Gateway object in contrast to a User object allows additional dialing digits to be sent. Also for incoming calls the incoming calling party number is passed on.

== Gateway Object specific Configuration ==

;Enblock Count: If this number of digits is dialed after the number of the Gateway object itself, the call is sent out as enblock call. This is useful to connect to gateway which are not capable of overlap receiving.

;Enblock as Diverting No: If this checkmark is set, the called party number is transmitted as diverting leg2 information. As called party number the number of the gateway object is sent or no number if the Prefix checkmark is set. This is useful with Microsoft Exchange since this expects the number of the mailbox as diverting number.

;Prefix: If this checkmark is set, the number of the Gateway object itself is removed from the called party number for outgoing calls and added to the calling party number for incoming calls

;Domain: Route calls with matching domain part in the destination to this object.

;Loop Detect: If checked outgoing calls are blocked if a call with identical source and destination addresses already exists.

;International Match: If a call is received with an international calling party number, it is compared to this number. If there is a match (head match) this number is removed from the calling party number, so that only additional digits remain. If the calling party number does not match, it is removed completely. e.g. on an incoming call from a registration on this Gateway object the CGPN I49703173009123 will be mapped to 123.

;National Match: Same as 'International Match' only for national calling party number. e.g. on an incoming call from a registration on this Gateway object the CGPN N703173009123 will be mapped to 123.

;Subscriber Match: Same as 'International Match' only for subscriber calling party number. e.g. on an incoming call from a registration on this Gateway object with the CGPN S73009123 will be mapped to 123.

;Internal Destination: If this checkmark is set, all calls from devices registered at this object are marked as Internal (Numbering plan set to private). This is usefull if systems are registered to this object, which cannot send calls with the private numbering plan but should be regarded as internal (e.g. voicemail systems).

The device registering with a gateway object is normally expected to send local extension numbers as calling party number (i.e. extensions local to the PBX and 'behind' the gateways own number). However, if it sends these numbers as full numbers (that is, including the various prefixes such as county code, are code, trunk, etc.), these can be stripped using the next 3 fields:

;No Inband Disconnect: If this checkmark is set, a call disconect with inband information will not be forwarded to the endpoint registered to the user, but the call will be cleared immediatelly without the inband information beeing sent..

;Fax License: TBD.

;Filter: The filter configured here restricts the numbers which may be called by through this object.

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Gateway object, Gateways registered to the same device config are used round-robin. The gateways registered to different devices are used in the sequence of the configured devices.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Gateways object are diverted.
;CFB: A CFB is executed if a call is rejected with ''User Busy'' by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (''no channel'', ''no gatway registered'', ...)

Reference11r1:Gateway/Interfaces/Physical

2015-10-05T07:52:15Z

Tle: /* General Configuration */

On this page a physical interface (ISDN or FXS) can be configured for Gateway use. Number mapping may be configured to normalize the called and calling numbers for internal use. An interface may be registered to a gatekeeper. If this is configured a VOIP interface and routes are generated automatically.

== General Configuration ==

;Name: Name of the interface. This name is used for local administration only (e.g. it is display in the routing table)

;Disable: Used to disable the interface without deleting the config

;Tones: This configures the tone scheme for this interface

;Send Date/Time: If this checkmark is set, the current local time will be transmitted within ISDN connect messages. Ther is ISDN equipment using this to set the local time

;Set Date/Time: If this checkmark is set the Date/Time-information received in connect messages from this interface is used to set the system time. This works only if the Date/Time information is provided as local time '''and''' the timezone is set according to this local time. The accuracy of Date/Time information is +/- 1min, so the system time is changed only if it is more than 1.5min different from the received information. Please note that it is strongly recommended to [[Howto:Obtaining the current time for innovaphone devices using NTP|use an NTP server]] instead, as it has better accuracy.

;Ack incoming call: If this checkmark is set, a SETUP-ACK or CALL-PROC message is sent back on incoming calls right away. This should not be necessary, but it can happen that a PBX object is sending a CONN as first message to incoming calls and even though this is perfectly according standard, some old style PBXs don't like it.

== Interface Maps ==

The number mapping on the interface can be either configured manually, or predefined mappings for ISDN Point to Point or ISDN Point to Multipoint interfaces can be used. If predefined mappings are used they can be edited the same way as manual mappings, but if they are changed they are not recognized as predefined mapping any more. Please read also [[Reference9:Gateway/Interfaces#ISDN interfaces (PPP, TEL1-4, BRI1-4, PRI1-4)]]
=== Point to Point ===

With the use of a few parameters the Point to Point mapping maps between an external representation of the numbers using the type of number field and an internal representation using Unknown as type of number and prefixes.

{|
|valign=top nowrap=true|'''Area Code'''
|The prefix used to convert from a subscriber number to a national number
|-
|valign=top nowrap=true|'''Subscriber Number'''
|The prefix used to convert from an extension to a subscriber number
|-
|valign=top nowrap=true|'''National Prefix'''
|The prefix used to mark a number as National
|-
|valign=top nowrap=true|'''International Prefix'''
|The prefix used to mark a number as International
|}

=== Point to Multipoint ===

With the use of a few parameters the Point to Point mapping maps between an external representation of the numbers using the type of number field and an internal representation using Unknown as type of number and prefixes. Three external numbers (MSNs) are mapped to internal extensions.

{|
|valign=top nowrap=true|'''MSN1-3,Ext.'''
|The external subscriber numbers and the internal extensions they are mapped to.
|-
|valign=top nowrap=true|'''National Prefix'''
|The prefix used to mark a number as National
|-
|valign=top nowrap=true|'''International Prefix'''
|The prefix used to mark a number as International
|}

== Internal Registration ==

=== H.323 ===

Registration to a Gatekeeper/PBX

;Gatekeeper Address (primary/secondary): The registration addresses of the PBX/Gatekeeper. If no adress is configured, Gatekeeper Discovery is used

;Gatekeeper ID: ID of the Gatekeeper. On a innovaphone PBX, this is the System Name. It is recommended to configure this to avoid registration to the wrong PBX.

;Name: H.323 Id used for the registration. If no name and no number is configured a name of the form <product-short-name>-<last 3 Bytes of Mac Address>-<Interface Id> (e.g. IP800-08-03-01-TEL2) is used instead.

;Number: The number used for the registration. Typically only name or number is required.

;Password: Password used for authentication if needed.

=== SIP ===

Registration to a SIP Server

=== Media Properties ===

The physical interface may be registered using H.323 or SIP. For the VOIP call the media properties can be configured.

;General Coder Preference: The coder preference (Coder, Framesize, Silence Compression) to be used if a non-local media address is detected. If the preference is marked as exclusive no other coder is offered.

;Local Network Coder: The coder preference if a local media address is detected.

;Enable T.38: Switches on Fax detection and switchover to T.38

;Audio FAX support: Switches on voice coder e.g. G.711 for the FAX interface. This feature requires two free DSP channels and is '''not available''' on IP2x, IP302, IP305, IP800 gateways. If you send an outbound fax there is no Audio Fax Support Fallack (T38 -> g711) if you have to activate g711/exclusive + Media Relay at the SIP Interface.

;No DTMF Detection: Special mode to switch off DTMF detection during a call. If checked DTMF is transferred inband during a call. Use G711 coder and a link with no packet loss to transfer DTMF inband. This option can be used to transfer continuous DTMF tones for some special applications. Out of band DTMF tones have a fixed length of approx 150ms.

;Enable PCM: Enable the media to be connected using the local timeslot switch if the call is between physical interfaces of the same gateway.

;MOH Mode: Special mode to use a physical interface as Music on Hold Source. The media is one way only and multiple calls are connected to the same channel on the physical interface. In this case the configured coder is used exclusively, even if not marked as exclusive.

;Record to (URL): HTTP URL where the recording file is to be stored. HTTP server must allow write access (PUT) at this location. One PCAP file is written for every call via this interface containing both RTP streams. Audio streams can be played using Wireshark. PCAP file can be converted into WAV file using pcap2wav tool. The filename of the recording file has the form <conferemce ID>-<mac>-<seq>.pcap
:;conference ID: A guid identifying the call accross different hops. It is forwarded within the signaling. The CDRs generated by the PBX contain this conference ID.
:;mac: The Mac address of the device recording the call. Together with '''seq''' it is used to make shure the filename is unique if seperate devices record the same call.
:;seq: A sequence number of the record starting with 0 after power up of the recording device. Together with '''mac''' it is used to make shure the filename is unique, esspecially to cover the case, that one device records the same call multiple times (e.g. incoming and outgoing)

=== Feature Code Support ===

The '''Feature Code Support''' turns on Supplementary services for a single endpoint connected to the physical interface, which can be invoked using *# dial sequences. This is availabe on FXS interfaces only.

;Dynamic Group: The name of the group which membership can be changed using *# sequences from the endpoint.

;Direct Dial: Number to be dialed on off-hook. This only works if feature code support is enabled.

;Locked White List: A white-list of numbers, separated by ',' which may be still dialed if the endpoint is locked using *# sequences.

Reference11r1:Gateway/Interfaces/Physical

2015-09-11T10:02:25Z

Tle: /* General Configuration */

On this page a physical interface (ISDN or FXS) can be configured for Gateway use. Number mapping may be configured to normalize the called and calling numbers for internal use. An interface may be registered to a gatekeeper. If this is configured a VOIP interface and routes are generated automatically.

== General Configuration ==

;Name: Name of the interface. This name is used for local administration only (e.g. it is display in the routing table)

;Disable: Used to disable the interface without deleting the config

;Tones: This configures the tone scheme for this interface

;Send Date/Time: If this checkmark is set, the current local time will be transmitted within ISDN connect messages. Ther is ISDN equipment using this to set the local time

;Set Date/Time: If this checkmark is set any time information received in a connect message from this interface is used to set the local time. The accuracy of this time is +/- 1min, so the time is changed only if the local time is more the 1.5min different from the received time. Please note that it is recommended to [[Howto:Obtaining the current time for innovaphone devices using NTP|use an NTP server]] instead, as it has better accuracy.

;Ack incoming call: If this checkmark is set, a SETUP-ACK or CALL-PROC message is sent back on incoming calls right away. This should not be necessary, but it can happen that a PBX object is sending a CONN as first message to incoming calls and even though this is perfectly according standard, some old style PBXs don't like it.

== Interface Maps ==

The number mapping on the interface can be either configured manually, or predefined mappings for ISDN Point to Point or ISDN Point to Multipoint interfaces can be used. If predefined mappings are used they can be edited the same way as manual mappings, but if they are changed they are not recognized as predefined mapping any more. Please read also [[Reference9:Gateway/Interfaces#ISDN interfaces (PPP, TEL1-4, BRI1-4, PRI1-4)]]
=== Point to Point ===

With the use of a few parameters the Point to Point mapping maps between an external representation of the numbers using the type of number field and an internal representation using Unknown as type of number and prefixes.

{|
|valign=top nowrap=true|'''Area Code'''
|The prefix used to convert from a subscriber number to a national number
|-
|valign=top nowrap=true|'''Subscriber Number'''
|The prefix used to convert from an extension to a subscriber number
|-
|valign=top nowrap=true|'''National Prefix'''
|The prefix used to mark a number as National
|-
|valign=top nowrap=true|'''International Prefix'''
|The prefix used to mark a number as International
|}

=== Point to Multipoint ===

With the use of a few parameters the Point to Point mapping maps between an external representation of the numbers using the type of number field and an internal representation using Unknown as type of number and prefixes. Three external numbers (MSNs) are mapped to internal extensions.

{|
|valign=top nowrap=true|'''MSN1-3,Ext.'''
|The external subscriber numbers and the internal extensions they are mapped to.
|-
|valign=top nowrap=true|'''National Prefix'''
|The prefix used to mark a number as National
|-
|valign=top nowrap=true|'''International Prefix'''
|The prefix used to mark a number as International
|}

== Internal Registration ==

=== H.323 ===

Registration to a Gatekeeper/PBX

;Gatekeeper Address (primary/secondary): The registration addresses of the PBX/Gatekeeper. If no adress is configured, Gatekeeper Discovery is used

;Gatekeeper ID: ID of the Gatekeeper. On a innovaphone PBX, this is the System Name. It is recommended to configure this to avoid registration to the wrong PBX.

;Name: H.323 Id used for the registration. If no name and no number is configured a name of the form <product-short-name>-<last 3 Bytes of Mac Address>-<Interface Id> (e.g. IP800-08-03-01-TEL2) is used instead.

;Number: The number used for the registration. Typically only name or number is required.

;Password: Password used for authentication if needed.

=== SIP ===

Registration to a SIP Server

=== Media Properties ===

The physical interface may be registered using H.323 or SIP. For the VOIP call the media properties can be configured.

;General Coder Preference: The coder preference (Coder, Framesize, Silence Compression) to be used if a non-local media address is detected. If the preference is marked as exclusive no other coder is offered.

;Local Network Coder: The coder preference if a local media address is detected.

;Enable T.38: Switches on Fax detection and switchover to T.38

;Audio FAX support: Switches on voice coder e.g. G.711 for the FAX interface. This feature requires two free DSP channels and is '''not available''' on IP2x, IP302, IP305, IP800 gateways.

;No DTMF Detection: Special mode to switch off DTMF detection during a call. If checked DTMF is transferred inband during a call. Use G711 coder and a link with no packet loss to transfer DTMF inband. This option can be used to transfer continuous DTMF tones for some special applications. Out of band DTMF tones have a fixed length of approx 150ms.

;Enable PCM: Enable the media to be connected using the local timeslot switch if the call is between physical interfaces of the same gateway.

;MOH Mode: Special mode to use a physical interface as Music on Hold Source. The media is one way only and multiple calls are connected to the same channel on the physical interface. In this case the configured coder is used exclusively, even if not marked as exclusive.

;Record to (URL): HTTP URL where the recording file is to be stored. HTTP server must allow write access (PUT) at this location. One PCAP file is written for every call via this interface containing both RTP streams. Audio streams can be played using Wireshark. PCAP file can be converted into WAV file using pcap2wav tool. The filename of the recording file has the form <conferemce ID>-<mac>-<seq>.pcap
:;conference ID: A guid identifying the call accross different hops. It is forwarded within the signaling. The CDRs generated by the PBX contain this conference ID.
:;mac: The Mac address of the device recording the call. Together with '''seq''' it is used to make shure the filename is unique if seperate devices record the same call.
:;seq: A sequence number of the record starting with 0 after power up of the recording device. Together with '''mac''' it is used to make shure the filename is unique, esspecially to cover the case, that one device records the same call multiple times (e.g. incoming and outgoing)

=== Feature Code Support ===

The '''Feature Code Support''' turns on Supplementary services for a single endpoint connected to the physical interface, which can be invoked using *# dial sequences. This is availabe on FXS interfaces only.

;Dynamic Group: The name of the group which membership can be changed using *# sequences from the endpoint.

;Direct Dial: Number to be dialed on off-hook. This only works if feature code support is enabled.

;Locked White List: A white-list of numbers, separated by ',' which may be still dialed if the endpoint is locked using *# sequences.

Howto:Upgrade IPxxxA to support more DRAM Memory

2015-05-28T15:38:47Z

Tle: New page:  ==Applies To== * IP110A, IP240A with lower software versions than V11R2 SR1 ==Problem== New IP110A and IP240A are preinstal...

==Applies To==
* IP110A, IP240A with lower software versions than V11R2 SR1

==Problem==
New IP110A and IP240A are preinstalled with software which do not support the bigger DRAM. The phones also ''don't know'' that they are '''A''' and therefore they cannot automaticly be updated over the update server with update-ipxxx'''A'''.htm

==Summary==
If you have only IP110A and/or IP240A update the bootcode to V11R2 SR1 or later. After the update (and reset) the phones have bigger DRAM and the (system internal) name is changed to IPxxxA.

The easiest way to do this via update server is to use update-IP110.htm and update-IP240.htm (not update-IP110'''A'''.htm or update-IP240'''A'''.htm because phone does not know the '''A''')

1. Update the bootcode and reset the phone (if you use an existing script comment out the prot line for the firmware update)

mod cmd UP0 boot http://x.x.x.x/DRIVE/CF0/update/v11r2sr1/boot110a.bin /ser xxxx
#mod cmd UP0 prot http://x.x.x.x/DRIVE/CF0/update/v11r2sr1/ip110a.bin /ser xxxx
irebootn

2. Update the firmware
mod cmd UP0 boot http://x.x.x.x/DRIVE/CF0/update/v11r2sr1/boot110a.bin /ser xxxx
mod cmd UP0 prot http://x.x.x.x/DRIVE/CF0/update/v11r2sr1/ip110a.bin /ser xxxx
irebootn

If you have a mix with IP110 and IP110A and/or IP240 and IP240A you can use the same update script for IPxxx and IPxxxA. IPxxx will ignore the bootcode for IPxxxA

After this procedure you can use the update path without the .bin files. But from this point on you need for the '''A''' phones own .htm files (i.e. update-IP110'''A'''.htm)

mod cmd UP0 boot http://x.x.x.x/DRIVE/CF0/update/v11r2sr2/ /ser xxxx
mod cmd UP0 prot http://x.x.x.x/DRIVE/CF0/update/v11r2sr2/ /ser xxxx
irebootn

Howto:XCAPI

2015-03-06T10:43:12Z

Tle: /* One way audio using SRTP */

==Applies To==
This information applies to

* Configuring the XCAPI with the innovaphone Gateways and innovaphone PBX

== Introduction ==

This document is intended to support you with the integration of the XCAPI (version 3.4.0.0) into an existing environment of
current innovaphone gateways (Version 6 and following). In the following sections we describe the essential steps of configuration to allow for optimal cooperation of both the XCAPI and the innovaphone PBX/gateway. At this point, we suppose that the innovaphone PBX, the hardware the XCAPI is running on and both the XCAPI and your CAPI applications are already installed properly. For some extended information on installation procedures please refer to the respective manuals. A short installation manual for the XCAPI is available at the XCAPI Homepage (http://www.te-systems.de/community/index.php?L=0).

Both XCAPI and Innovaphone support H.323 and SIP and we can configure the Trunk between them using the Gateway/Relay or directly registering XCAPI on the PBX. However the only method recommend to be used it's registering XCAPI directly on the innovaphone PBX using SIP Protocol.

=== Configuring the innovaphone ===
In this example, we are going to use one PBX gateway object (XCAPI-SIP-GW) and register XCAPI on this Object.

==== Creating a Gateway Object in the PBX ====
Log in to the PBX administration and create a new gateway object. The name of the object is "XCAPI-SIP-GW", and the number is 93 in this case.

[[Image:2-pbx-gw-object-gw-4-config.PNG]]

[[Image:XCAPI_no_iband_disconnect.PNG]]

Note: At this Gateway Object we should select the option "No Inband Disconnec" to avoid issues with external call transfer that are rejected.

=== XCAPI Configuration ===
When the XCAPI configuration is started for the first time, there are no configured controllers. Use the link "Click here to add a controller" in the overview page to start the controller wizard.

[[Image:controller-wizard-0.PNG]]

==== Add new VoIP controller ====
On the welcome page of the controller wizard, select to add a new VoIP controller.

[[Image:controller-wizard-1.PNG]]

==== Network Interface ====
In the next dialog, select the network interface that you want to use for the SIP connection between the XCAPI and the innovaphone gateway.

[[Image:controller-wizard-2.PNG]]

==== Select VoIP environment template ====
From the list of predefined VoIP environments, select a innovaphone (PBX object) template.

[[Image:controller-wizard-3.PNG]]

==== Signalling Protocol ====
We must select SIP as protocol to be used by XCAPI.

[[Image:controller-wizard-4.PNG]]

==== innovaphone (PBX Object) ====
Here we must insert the innovaphone PBX System Name or IP address. This will depend on the option "Use as Domain" at PBX->Config.

If we have "Use as Domain" we insert the system name of the PBX:

[[Image:controller-wizard-5a.PNG]]

Then if the System name it's not resolved by DNS we need to configure SIP Proxy in the XCAPI Configuration after we finish the Wizard:

[[Image:controller-wizard-5b.PNG]]

If there is no "Use as Domain" we configure the IP address of the PBX:

[[Image:controller-wizard-5.PNG]]

==== User Information ====
Here we insert the GW Object Name previously created at "Username" field, the use of password it's optional.

[[Image:controller-wizard-6.PNG]]

==== Description and channels ====
Enter a meaningful description and the number of lines that the XCAPI can use to communicate with the innovaphone gateway simultaneously.

[[Image:controller-wizard-7.PNG]]

==== Confirmation ====
Check if all necessary information has been entered correctly (green symbols on the left) and confirm all data by clicking Finish.

[[Image:controller-wizard-8.PNG]]

Then the new controller appears in the XCAPI configuration. Save the changes and stop all running CAPI applications before restarting them.

[[Image:controller-wizard-9.PNG]]

== Known Problems ==

=== No MOH ===

* In XCAPI version 3.3.249 when XCAPI puts call on hold it uses media attribute "send-only", this could affect some call scenarios by not providing MOH to the held party. In order to PBX provide the MOH the hold must be set with media attribute "inactive" instead. In future releases of XCAPI it's planned that "inactive" will be set already in the template for innovaphone PBX meanwhile you can edit in the configuration this option like the image bellow shows. Also other option that should be enable it's "Send attribute "Recvonly" when being held" for the cases that XCAPI it's put on hold.

[[Image:controller-wizard-10.PNG]]

* If you perform a consultation transfer with XCAPI (example using Voxtron Agent hold incoming PSTN call and does consultation transfer with alerting to another agent) and the held party doesn't hear the MOH/Alerting from the PBX then the reason could be the default option in XCAPI configuration to "Discard incoming audio data when held".

[[Image:controller-wizard-11.PNG]]

=== Failure on Registration due missing Username ===

* Gateway Object with Password requires extra step of configuration on XCAPI settings after XCAPI wizard it's finished. For that reason we need to insert the Name/Number for registration at field "Username(Authorization)" at XCAPI SIP Settings.

[[Image:controller-wizard-12.PNG]]

=== Incoming call declined by PBX ===

*If the registration is successful but an incoming call is declined by the PBX due to an unknown contact header you should enter the xcapi object name as contact parameter in the XCAPI configuration.

[[Image: Xcapi-contact.png]]

- On v10sr8/V10sr9 the previous behaviour was fixed so the Contact Info should have no value, if you set value like the example this will cause problems with the SIP Register after a restart of the Gateway.

- On v10sr10 there is a fix for the SIP Register issue, so you can set a name on the Contact Info or leave it blank both methods will work.

=== One way audio using SRTP ===
XCapi does not support SRTP unless the optional XSSA Module is installed. If SRTP is used anyway, one-way-audio may occur (from XCapi to innovaphone endpoint).

If you do not want to install XSSA (and thus use un-encrypted RTP to the XCapi), cou may (from XCAPI Version 3.4.x on) enable the XCAPI Tweak <''REJECT_UNACCEPTABLE_SDP''> to reject calls with unsupported SAVP (i.e. SRTP) media requests.

[[Image:XCAPI_Tweak_reject_unacceptable_SDP.jpg]]

The calling innovaphone device will then re-initiate the call w/o SRTP.

For more information about XSSA please contact TE-Systems.

=== T38 / Fax failed ===
T38 will not supported if the option "Software Fax über Sprachkanäle benutzen" is enabled. If required disable this option.

[[Image:Xcapi_controller_features_softax.png]]

== Related Articles ==



* http://www.xcapi.de
* http://www.te-systems.de

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

Reference10:Voice Recorder/System Setup

2014-12-08T11:21:13Z

Tle: /* IP-Phone setup */

This helps describe the setup of components involved in the recording solution. For a description of the recorder setup see Related Articles.

= Reporting Setup =

In the reporting there is no special setup required. If running on a VMware assure that the reporting starts each time with the same IP address.

The recorder requires reporting Version 10, Build 10043 or higher.

Important: Each extension producing a .pcap file must be included in the reporting!
If just some extensions should be recorded (and just for them reporting licenses are foreseen) a special setup in the routing is required to assure that just those extension will pass the recording GW.

= PC Setup =

As always the PC World is full of traps and therefor in this section we try to collect some. We show you also if possible what the result will be. Of cause the exact wording of the messages depends on the language of your computer.

'''Where is the application and where are the setup data?'''

The application is installed in the Folder “\Programs\innovaphone\innovaphone Recorder”. If you install the recorder on a 64 bit machine instead of “\Programs” you will find the application the “Program (x86)” folder.

The setup data are stored in the folder “\user\yourUser\AppData\Roaming\innovaphone\innovaphone Recorder”.

If you don’t see the folder “AppData” you must switch on the option of the file explorer in the Tab Views the flag “show hided files and drives”. Observe that the recorder can save his data also in the directory where he is running (depends on the relative flag in his setup).

'''First start after installation'''

Open immediately the setup to avoid that the recorder tries to recover error because of an empty setup. The application recognizes this first startup, anyway open the setup. Remember as jet stated that before starting to work with the recorder the basics should run (PBX, Groups, Soap user, reporting, Webdav, recording path, all this should be up and running fine).

'''Start up with administrator rights'''

The Recorder needs to be started with administrator rights. Therefore or you are logged as administrator or you must start the application as admin (right mouse click on the application, “start as admin”). If you start the application without hose rights probably the alarm “Disk” and “Setup”, for Shure the “CF” alarm will be displayed and no webdav access is possible.

'''Webdav'''

The Webdav access is particular darn and there are many reasons why an access could fail.

So if it works fine, otherwise continue reading and proceed in this way:

Try first to map a drive to the webdav using the file explorer (click on Network, connect network drive, assing a letter and put in the field path your path to the webdav (for example \\172.o.m.g\DRIVE\CF0\). If this mapping works fine, you can now separate again this drive.
If not check you Proxy, that is generally a good idea, because sometimes the proxy is responsible that the attempt to reach a network drive fails. So switch off the proxy off for this PC. Firewalls and other components in the net or local on you PC can also block the access to the webdav, also in this case the manual mapping fails (and if manual fails also the recorder will fail).

Note that the syntax to reach the webdav is different for a CF or an Webdav server on the linux application platform.

Another strange reason for not connecting a NW drive could be the letter you assign in the recording setup. For example “H:” sounds good, you check your explorer and see that this letter is not assigned to any drive, so “free” for your understanding. To be shure that this is really a assignable “free” Drive letter for your machine you have 2 choices; user a “low” letter like “Y:” or “Z:” or use the letter that works with you manual mapping trial, or flag “Detect automatically” and observe the letter the PC try to map (you see that in the (right) syslog panel.

A stupid but even not forgiving issue is the correct setup, a wrong or missing slash or backslash will fail the mapping. Observe the path in the first picture at the beginning of this article; this is the syntax for a compact flash!
Now if you scroll down to the section “GROUP PCAP” you see a example for an access to webdav running on an innovaphone application platform.

Before despair check also the correct admin and password, remember that typically the PW in the application plattform is “linux”.

'''Platforms'''

SERVER:

If you use a server (for example WIN2008) you have to face that on that server you must active the “Desktop Experience Features”.

PC:

If you use a "normal” Win7/8 PC you have not the "Experience" issue, but to fix the problem that Microsoft limit fro "not servers" the maximum file size and you can run in problems because very long conversations could not be downloaded from the webdav server. A typical maximum size id 50MB, so you have to solve this, here is how.

See http://support.microsoft.com/kb/900900/en-us for more information and how resolve this limit. Our suggestion is to enlarge this limit at least to 500MB.

The recorder will have an error like “Error in rename PCAP files" or “Error file to large – enhance max file size in registry” or similar.

Follow the instructions given by MS and be carefully, the following sum-up just resume what usually the manual way to solve the problem is and MS writes in his KB:

To resolve this issue, follow these steps:

1. Click Start, click Run, type regedit, and then click OK.

2. Locate and then click the following registry subkey:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters

3. In the right pane, right-click the FileSizeLimitInBytes value, and then click Modify.

If you cannot see the FileSizeLimitInBytes value, right-click the blank space in the right pane, click New, click DWORD Value, type FileSizeLimitInBytes, and then click OK.

4. In the Edit DWORD Value box, click to select the Decimal option. In the box under Value data, type a value that is larger than the size of the file that you want to download. Click OK.

Note The default value for the file size limit is 50000000 bytes.

5. Quit Registry Editor. Restart the computer.

[[Image:Filesize.png]]

= Gateway Setup =

The voice has to transit a logical GW where the [[Reference9:Gateway/Interfaces/VOIP#Media_Properties | URL “Record to (URL)”]] is defined. Including or excluding extensions in the routing allow selective recording of just defined extension (or exclude some extensions). Also mapping in the PBX can be used to manipulate call routing. See relative chapters in the Wiki.

Example:

[[Image:VR006.png]]

Note: The Media Properties for this GW has to be set to G711A Exclusive! Therefore just this codec can be recorded. The media relay flag has to be switched on to force audio pass-through (and therefore recording) also in case if IP to IP calls.

Voice recording means CPU and storage load and a clever layout can minimizes the usage of those resources while especially in huge scenarios an unconcerned one can cause huge workload.

First of all record possibly just what is necessary. If you have for example 2000 user but you have to record just 20 of them, recording all traffic is not a brilliant idea. Because the PBX CPU streams all the conversations down to the CF/Webdav, then the recorder has to delete 99% of those files. Not really a big deal if absolutely necessary, but probably there is a smarter way. For example record directly just the 20 IP-Phones phones.

The CDR0 or CDR1 must point to the reporting tool (Type = “REMOTE-AP”, IP address and Port 80).

Note: on the trunk object the flag “reporting” must be on (and you will need one reporting license for that).

= IP-Phone setup =

Voice recording can be done by the Gateway but also directly by the innovaphone IP-Phone.

Doing VR using the IP-Phone has the following advantages or disadvantages; it depends on your point of view and the scenario.

- CPU-Load: No CPU power from the PBX is required, a Phone has enough CPU-Power to do that and more, and therefore it becomes an extremely scalable solution. If you do not use an external WebDAV server but a CF anyway the PBX CPU has some load (playing WebDAV server for the Phone)

- All calls on the phone are recorded (not just those crossing a gateway), so even internal calls (basically everything the phone is doing).

- Al users working on the phone are recorded. This means also that each possible user on the phone must have the reporting license otherwise a call from that user will cause a major alarm.

- Transferred calls to other extensions are after the call transfer no longer recorded. In case of gateway recording it is different, until the call cross the gateway recording is done.

- If you mix both setup in a scenario you should avoid that a Phone is doing recording and cross a gateway doing recording too. If that happen recording is done in two points and you double for nothing disk space and resources (and confuse everybody).

- Only innovaphone IP-Phones IP2x2 series and “A”-types (like IP110A, but not IP110) can performing VR directly.

If you like or must do recording not in the GW but in the IP-Phone, here is how:

Switch on the recording has to be done in the phone setup file, there is no menu option.

Save the setup file of the phone, open an editor, edit the setup and load the setup up again.

In the setup you will see a row beginning with “config change PHONE SIG”, that is the strategic point to edit.

The command to add is:

<nowiki>/record http://xx.yy.zz.uu/path</nowiki>

Example:

Your config line is like that:

config change PHONE SIG /no-intrusion-tone on /prot H323 /gk-addr 172.16.88.98 /e164 37 /tones 0 /lcoder G711A,20, /coder G711A,20,

while you recording path is on the CF in the directory “RECORDING” and your PBX has the IP-Adress 172.16.88.98. you line must be the following:

<nowiki>config change PHONE SIG /no-intrusion-tone on /prot H323 /gk-addr 172.16.88.98 /e164 37 /tones 0 /lcoder G711A,20, /coder G711A,20, /record http://172.16.88.98/DRIVE/CF0/RECORDING</nowiki>

Note: After the 'config change' command it's necessary to write and activate the changes

<nowiki>
config write

config activate </nowiki>

= Multiple Voice Recorder and Player =

This section describes how to run more than one Voice recorder and player on one single PC and one single user.

== Voice Recorder ==

If you install more than one recorder running on one single PC user (obviously in different directories) you face the problem that both share the same setup.
That is so because the recorder writes his setup and log files in the “user\AppData\roaming\innovaphone\innovaphone Recorder” directory.
Therefore in the genera Panel of the setup of the recorder there is a flag “save setup in own directory”; if flagged the setup will be saved in the directory where the recorder is running. Admin rights are required (or at least the recorder application must be launched with those credential, right mouse and “start ad administrator”).

Technically all recorders will load after the start-up in the user-appdata directory the setup and find out that the data should be retrieved and stores in the local directory. Therefore the “own” directory is detected and the local setup loaded.

Note that each voice recorder has to interface the PBX SOAP where the recording user are registrated and each recorder must have his own CF/Webdav directory. Each recorder must have also his own and different group.

Example 1: One singe PBX, two groups of user to record on 2 recorder. Load the license for the total number of use to register in the master PBX, assign each group a different recording group name. Install the recorder in different directories and do the setup, the SOAP user and the reporting is the same. But you have to store the recording pcap files on different directories. In some cases this is quite simple because you route the outgoing and incoming traffic over different GW pointing on different directories of the CF/Webdav. In some cases this is difficult or impossible, and so the only way is that the user of one group records directly from the innovaphone IP-Phone in a separate directory.

Example2: Master/Slaves where the Salve user are registrated in the salve and not in the master PBX. But all users use the same trunk line on the slave site. There should be recorded user in the master and user in the salve PBX. Even in this case you need 2 recorder engines, one read out the SOAP in the master and record the user in the master and point to the SOAP of the salve PBX. The user in the slave PBX has to record directly from the phone to a dedicated CF/Webdav directoy.
Note that in case of more recorder the storing path could be the same, so the player will have all records in one directory.

== Player ==

If a user want run more Player on one PC that is probably because he want create different shortcuts on the desktop to start different player (with different setups).

Also the player stores his data in the user-app directory like the recorder, in the directory “user\AppData\roaming\innovaphone\innovaphone Player”. Of course doing so all players even if installed in different directories will access to the same setup, not a good idea. Therefore a player can be launched with an optional command indicating the directory where the setup should be loaded and stored. In the shortcut the directory must be inserted with a space after the command itself.

Example:

This is the original path in the shortcut:

"C:\Program Files\innovaphone\innovaphone Player\innovaphone_Player.exe"

If you add the path “c:\asdf\” the setup will be stored in that directory, so you have to change the property of the shortcut in

"C:\Program Files\innovaphone\innovaphone Player\innovaphone_Player.exe" c:\asdf\

(Note no quotation marks for the path and a space after the link to the setup directory)

= Player Setup =

See relative Related Articles

= Related Articles =

* [[Reference10:Voice_Recorder/Setup]]
* [[Reference10:Voice_Player/Setup]]
* [[Reference10:Concept_Voice_Recorder]]

= Download =
*[http://sox.sourceforge.net/ Download SoX executable for Win32 from sourceforge.net)]
*[http://sourceforge.net/projects/lame/files/lame/3.99/ Download Lame from sourceforge.net]

Reference10:Voice Recorder/Setup

2014-12-05T09:56:36Z

Tle:

The setup is stored in the directory where the recorder is running; therefore more recorders can be started on one single system using different directories. Please note that the setup file is a XML file but AES crypt, so not readable.

In the headline of the setup the version is displayed, note that the version can be displayed also in the recorder main menu clicking on the innovaphone logo.

The setup described in this page concerns version 10.00 of the Recorder Software.

The software was developed under Win7 but should operate also using windows Server (while the player software is not running without special setups using windows server).

The recorder requires reporting Version 10, Build 10043 or higher.

The recorder requires working Reporting software. The reporting can work on a physical gateway or on a VMware environment (even on a player). See relative articles how to setup the reporting tool.

A standard problem in the recorder setup is the correct link to the PCAP files. Therefore be precise in the relative Group and read the chapter.

= Recorder Setup =

Note: To map network drive an application must have administrator rights. Therefor the PC must run with admin credentials or at least the recorder application must be launched with administrator rights.

This decription concerns that screen:

[[Image:RecSetup01.png]]

== General ==

=== Recorder Name ===

This Name is displayed on the headline of the main menu and also reported in the start- up message log file.

===Password===

Password of this setup, if blank no password is asked to access to this setup. Please note that this password is also the default password for the player and can therefore be an important security feature.

=== Start in Taskbar ===
If checked the recorder will start minimized. Because the recorder has a complete user interface this software is not designed to run as a service. For automatic start-up include the .exe in the auto-start folder.

=== Trace ===

Do not confuse the logfile with the error logfile, the error log is written in any case and named iREC_Error_Log. This trace/logfile is called iRECsys_Log.txt and contains all operational tasks like copy of file, converting ecc., not just events like startup or errors. This flag should be switched on just in special situation for example during installation of a new system or in case of error searching, because this file becomes very huge and there is no automatic limitation foreseen.

=== Customer Key ===
The recorder encodes the record data files (the XML) using an internal standard key. If in this field a User Key is defined the encoding is done using this key. Therefore also in all players has to be configured this key. Remember that the decoding in the player depends on the local setup of the player. If no user key is defined the standard system key is used. If a user key is found a decoding is tried using that user key, if decoding fails the system key is used, if even that fails no decoding is possible.

Therefore once a user encoding key is defined it should not be changed, otherwise the “old” user encoded records cannot be decoded.

So if not really required leave this field blank, if you define a user endcoding key think well about it and...

WARNING: do not forget it (there is no way to find out the key).

=== Encode audio ===

Audio files are store in clear wave or mp3 format. Any media player could reproduce them, the integrity of those files is controlled from the innovaphone player. The audio file integrity data are stored in the encodet xml file.

If this option is checked also the audio file will be encoded using the same key used for encoding the xml file (see description in “Customer key”).

Encoding cause more CPU load for the recorder and the audio file size is doubled.

Once encoded an audio file can be reproduced only with the innovaphone player, if a customer encoding key is configured just if also in the player that key is used. In that case the audio file can be reproduced just with the innovaphne Player using the customer encoding key.

=== Save Setup in own directory ===

See chapter “Multiple Voice Recorder and Player/Voice Recorder"

=== Do not Record empty Files ===

Very short calls (typically seconds) causes very small recording files, so small that a reproduction is not possible (there is practically no audible audio data in).

The recorder can eliminate those files (recommended), but if for some reason you want keep those files (practically you just keep the call information from the reporting) do not flag this option.

=== Do NOT savew CDR data ===
If checked no CDR data are saved, just the audio files. If this option is switched on the player cannot display any additional call info. Also the integrity of the record cannot be assured (unknown) and a manipulation will not be detected. Also Agent notes are not possible and snapshots are disabled and even the original timestamp cannot be displayed on the player. Note also that a record once stored with this option on cannot be recovered later on.

=== Convert to Mono ===
Audio files are stores in stereo format where the external caller is on the left channel while the internal audio is on the right channel. This allows for example to amplify one channel more than the other etc. If this flag is checked the audio file format is converted from stereo to mono and the file size is reduced about 50%.

Remember that once converted to mono there is no way to restore the stereo image.

=== One channel audio ===
If checked just on channel is recorded, typically the left one because there the internal caller is speaking. If requested also only the right caller can be recorded. In most countries recording just the internal caller (recording myself) is permitted without limitations.

=== Softmigration===

(Build 1072 or later)

Check if the gateway is looped in between the PSTN and the PBX.

Do not mark in all other situaytions.

See relative Howto article for details.

=== MP3 indicator lamp ===

If a conversion from wave to mp3 audio format is requested some external files and utilities has to be present in the recorder directory. During start up the recorder check if all those requires files are present and if yes mp3 compression is switched on automatically and the lamp is green, if not conversion to mp3 is switched off and the lamp is gray.

===Work as http Player server (no recording)===

(Build 1074 or higher)
Warning: If checked the recorder will be just a http fileserver for the player, no recording is done!

Setup the storage path in the “Storage” tab and the Socket in the communication tab (COM WITH PLAYER). All other parameters are meaningless.

== PBX ==

Communication to the PBX is necessary because of licensing. Like in other applications admin access and SOAP user is required.

=== IP addr. ===
Indicate the IP Address of the PBX where the Recording licenses are in (the license master). Typical license are displayed in the PBX as “Recording10”.

=== IP addr. Stby ===
Indicate the IP address of the standby PBX. Leave blank if there is none.

=== User / Password ===
Of the PBX where the license are in. Default example: admin / ip800

=== SOAP USER ===
The SOAP user in the PBX where the licenses are stored has to be indicated. Usually it is a dummy user object in the PBX without any registration, for example a user called “SOAP” or “_TAPI_”.

=== Agent Group ===

Put all extensions where the recording feature is required in a group (not active) and define here the name of this group.

The recorder will read out all extensions during start up and initialize those belonging to this group. A result is that events from these extensions will be transmitted to the recorder.

Just extensions being part of that group will be recorded; eventual records of objects not in this group will be deleted. If a record is detected but the relative object is not in that group a message like “Record skipped Agent not in group” is displayed (but no error is triggered).

During start-up the recorder read out the number of license for recording stored in the PBX. Each time a object is in the recording group the number of free licenses is decreased. So the putting in the recording group is limited if the maximum number of license is reached.

Please note that in special situations, for example if you have a trunk line object but also a External object (a gateway) to a remote PBX both objects has to be in the group, otherwise calls form the trunk to the gateway will not be recorded.

Please note that there is a different behavior using a native CF or a CF emulated by the Linux application. A native CF will show a file name immediately when recording starts while the Linux OS will show the file just when the call is terminated. Therefore if you use a Linux OS and a user is not in the group even the counter “Channels in recording” is not showing the correct value.

=== HTTPS ===
Check if the PBX is using HTTPS.

== Reporting ==
The recorder has to be able to get ticket from the innovaphone reporting tool. The Reporting can run on a gateway or VMware (player or native), there is no difference for this setup.
=== IP address ===

Enter the IP address of the device where the reporting is running.

If you run the reporting on a PC enter the IP address indicated on the VMware virtual machine.

If not visible enter “ifconfig” in the VMware panel, the address is shown under inet addr. Remember that the address is usually not 127.0.0.1 (even if the reporting is running on the same PC).

=== IP addr. Stby ===

Indicate the IP address of the standby recording. Leave blank if there is none. Remember that both, active and standby PBX must sent the CDR tickets to both reporting applications and replication between must be switched on.
=== Follow Standby/Active PBX ===
If a switch (and especially an automatic switch back) to the active reporting is required flag this option “Follow Standby/Active PBX”. If this option is not flagged and the active PBX is on again the reporting will not switch back (until the recorder is not started again or the standby reporting fails).

=== User/Password ===

Enter the credential to access to the reporting, default is “admin” and “linux”.
=== Path Reporting ===

Enter the path to the main screen of the reporting, typical (and default) is “/apps/innovaphone-reporting/report.php”. Should work normally, do not modify this setup.

=== HTTPS ===

Check if the reporting is using HTTPS

=== Swap incoming/outgoing ===

What “incoming” or “outgoing” is depends on the point of view. If clicked “in” and “out” (“i”, “o”) are simply swapped.

=== No Reporting Sync ===
If checked the reporting is not synchronized with the voice recorder.
If not checked (default) the voice recorder informs the reporting if a stored recording is deleted and the database of the reporting is updated. Even if a Player delete a record (and has connection to the voice recorder) the recorder send relative information to the recorder, and the recorder again informs the reporting engine.

=== Alarm if no CDR ticket found ===

There must be for each recorded call a CDR ticket. If this option is checked an alarm (email) is trigger if there is no ticket. There are two situations where an alarm could trigger: if in online operation an agent (a user in the Agent group, means a user to record) end a call and there is no ticket after a time-out and after start-up where all pcap files buffered must be checked (agent or not) asking the reporting.

== PCAP ==

Note that the setup for a compact flash (CF) is different than the one using a webdav!

If you use our CF with the innovaphone application platform the CF is considered as a webdav service.

* CF:

[[Image:RecSetup88.png]]

IP addr. “172.16.88.98” (so no http or similar)

Typically User and Password are the one of the PBX, remember that the credentials CF must have write access.

Path PCAP “/DRIVE/CF0/MYrecDIR”

The result shown in the framed box will be “172.16.88.98/DRIVE/CF0/MYrecDIR/” and the recorder will try to access to this directory.

*Webdav:

[[Image:IRecN01.png]]

IP addr. “172.16.88.199/webdav”

Typically User and Password are the one of the application platform, admin and linux for example.

Path PCAP “/log/”

The result shown in the framed box will be “172.16.88.199/webdav/log/” and the recorder will try to access to this directory.

If you use a webdav server (if for example you have running the application platform) her again a typical setup for that:

===Delete old PCAP files after __ cycles===
If the recorder starts and found a old PCAP file where non SOAP information is available he will interrogate the reporting tool.

If the reporting will answer with “no record” the recorder waits a here indicated number of cycles before deleting the PCAP file on the CF.

Minimum Value = 2, require build 1071 or higher.

== Storage ==

The setup parameter in this panel defines where the recorder stores the records. While the Root storage Path is mandatory, the backup path is a option.

=== Set Root storage path ===

The path indicated in this option is the working directory where the files after retrieving, naming and converting are written. It is also the directory where the player will look and search for files.

If you click the “Set” button a directory dialog box appear, select the directory where you want store the voice records and confirm. You can edit the path even manually, not recommended.

=== Delete (records) after moth ===

The indicated number of month is the maximum storage depth. The minimum is 2 (so the actual and the last month will always be available), indicating 99 disable the feature. Deleted files cannot be recovered, the name of the deleted files are reported in the syslog.

Note that file in the backup path will never be touched.

=== Set Backup path ===

This path is optional; if blank the feature is off.

If you click the “Set” button a directory dialog box appear, select the directory where you want store a backup of the voice records and confirm. You can edit the path even manually, not recommended.

Note that files stored in the backup directory are not visible for the player and even the automatic delete is not active. The indicated directory is typically on a NAS or SAN system.

== Communication ==

=== COM WITH EXTERNAL APPLICATION (option) ===

Necessary if the recorder is interfaced to an external application, see reference help in the main window for details. Leave all blank if no external application is required.

=== Send TCP/IP Message – Lounch application string ===

Select the desired interface mode, the parameter of the not selected one are skipped.

=== Keep Alive ===

Indicate in seconds the time period between sending keep alive messages from the recorder to the external application (default=10 seconds).

=== IP address / Port ===

IP address / Port of the external application server.

Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.

=== Lounch path ===

URL to be launched.

=== COM WITH PLAYER (option)===

Communication with the player is an option, indicating a port number, it will be switched on from the recorder point of view and request from the player will be processed.

Indicate in the “port” field a free communication port while under “own IP address” the IP address of the PC is indicated.

The recorders try to find out automatically his “own” communication port; that sometimes fails in virtual environments. If the indicated IP address is not correct put in the right one (the on for this application).

Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.

To switch off this feature leave the port field blank.

Note: If the recorders works just as a fileserver for the player this address and port this is the communication socket for the player (Build 1074 or higher).

=== GROUP EMAIL ALARM (option) ===

If the recorder switch on the master alarm a supervisor can be receive an email.
The message object is "Voice Recorder " + Name of the recorder + " - ALARM NOTIFICATION", while the body text contains the last master alarm reason and the text "Automatic generated Alarm - Do NOT answer!".

Please note that a mail is sending just one time even if the error is recovered automatically (for example if the reporting is reachable again, then fails, then works etc.). To rearm the email the master alarm must be quit. This is intentionally to avoid tons of emails in case of toggling errors. The rule is that after an alarm email the application has to be checked.

=== e-mail account ===

Enter the destination email account for example kwa@innovaphone.com

If this field is empty the feature is off.

=== e-mail server ===

Enter the e-mail server, for example 155.5.23.24

=== Password ===

Not necessary for Exchange but could be.

== TCR ==

If this option is checked the Recorder will work in the Thread call Recording mode (TCR), if not in the standard mode (STD). No mixed mode is possible for one Recorder.

If TCR is on records will be saved only if the user define this call by call. That could be done automatically if calls are processed by innovaphone IP-Phones or on demand during a call if innovaphone IP-Phones are used.

But it is also possible to mark a call after the call end for a certain period, after that period the recorded file will be deleted. TCR files contain always the entire voice call from the beginning on , even if the mark is done during or after the call.

=== Thread Call Recording ===

Indicate the path to the XML file called from user to mark the call. Typically the XML is located at the CF, the example shows that the XML is running in the “TCR” directory of the CF.

=== Path TCR ===

Indicate the path to the XML file called from user to mark the call. Typically the XML is located at the CF, the example shows that the XML is running in the “/DRIVE/CF0/IF_REC” directory of the CF (not a good idea indicate the same directory than the one of the recording files, use a different one).

=== TCR flag Timeout ===

After that timeout calls not marked are deleted. A typical value is 5 minutes.

=== XML Number ===

If recording is done directly from the innovaphone IP-phone also that 3party confenece call (even if short) to the XML for marking is again a recorded. Indicate the XML number, so all calls to that number will be deleted automatically.

== Audio compression ==

The wave audio files are jet G711 compressed but stored as a stereo file in a wave container format. Storing native PCM would requires about the double disk space and is not done. One minute of raw PCM requires about 2 MB while the recorder reduces as default this size at 1MB.

Unfortunately if switched on audio encoding will double again this size. Even if the customer wants a very long period of storing data or has limited disk space additional compression would be fine. Mp3 compression can be switched on using external 3rd party software.

The recorder can pilot automatically external applications called “lame.exe” and “Sox.exe”. Lame is an open source (GPL) tool and even SoX is an open source (GPL) tool (SoX is described also in another Wiki article).

The recorder use no source code inside and calls the applications like a batch file (of cause providing relative command line info).

Do not “install” lame or SoX, just download the packages and copy the following files in the folder where the recorder is running:

- Sox.exe

- Lame.exe

- Libgomp-1.dll

- Pthreadgc2.dll

- Zlib1.dll

During start up the recorder check if those files are in the directory and if yes mp3 coding is on while if just one file is missing encoding is off. If you open the extended view of the recorder an mp3 Led shows you mp3 coding status (on or off).

With mp3 option on the required file size is reduced about 75% (1 MB will become 250kB).

Note that encoding audio files will double again the file size. Encoding can be done with wave or mp3 files. An encoded audio mp3 file requires anyway just 50% disk space that a clear wave file does.

= Other Setup =

For Reporting setup, PC setup, Gateway setup, IP-Phone Setup, Multiple Voce Recorder and Player see related Articles (System Setup)

= Related Articles =

* [[Reference10:Voice_Recorder/System_Setup]]
* [[Reference10:Voice_Player/Setup]]
* [[Reference10:Concept_Voice_Recorder]]

= Download =
*[http://sox.sourceforge.net/ Download SoX executable for Win32 from sourceforge.net)]
*[http://sourceforge.net/projects/lame/files/lame/3.99/ Download Lame from sourceforge.net]

Reference9:Phone/User/Function-Keys/Call-Forwarding

2014-09-08T14:34:56Z

Tle: /* Call Forwarding */

== Call Forwarding ==

This function allows incoming calls to be diverted. Four states with different destinations can be configured (for example, mobile phone, voicemail), which are offered in succession. In each of these states, the following options can be used:

* '''Always''' Continuous call diversion exists here.
* '''Busy''' Call diversion is activated when the user's telephone is busy.
* '''No response''' Call diversion is activated after a time delay, for instance after four dial tones.
* '''Apply 'Always' Setting Only''' If "Apply 'Always' Setting Only" is checked the Function key toggles only over the 'Always' (i.e. CFU) entries and keeps other existing diversions untouched. Thus CFB or CFNR diversions set at the phone or at the PBX are not changed when toggling this key. (since V8 hf10)

''Tip: Since the current call diversion is displayed on the display, the key labelling can be used to announce the next state to follow (active state). In the last state, it should therefore be displayed that further activation activates the state "0" without call diversion.''

Please note that telephones registered with SIP can not set call forwarding in the PBX (as there is no standard to do so in SIP). Instead, the phone must perform and thus store the information locally. To enable this behaviour, you need to issue the command (since v9/v10) <code> config add PHONE SIG /local-cf on</code> or (since v11) <code>config add PHONE/SIG /local-cf on</code>

As such call forwards are executed by the phone itself, they will work only if the phone is up and running and registered.

Reference9:Concept USB Headset

2014-09-04T12:23:08Z

Tle: /* '''Jabra UC VOICE 550 / 750''' */

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

The IP222 and IP232 telephones provide USB ports. This document describes how to install, configure and use USB headsets on these phones.

==Applies To==
This information applies to
* IP222 and IP232
Firmware V9hotfix7 and later.

USB Headset Support is ''in beta as of V9hotfix7'' and should thus not be used in production environments!

'''Note:''' USB Headsets supported by the '''innovaphone SoftwarePhone''' can be found [http://wiki.innovaphone.com/index.php?title=Reference9:Concept_USB_Headset_For_SoftwarePhone here].

==More Information==

===Disclaimer===
Only the devices listed here has been tested or will be tested by innovaphone AG, therefore only these headsets are supported by us. But nevertheless you could not be sure, every device with the same label or the same part number will work in the same way, because of different product codes or modified firmware. So it is recommended to test the headset before buying.

It is also a good idea, to install the software attached to the headset on the PC and first connect the device to the PC to update the firmware and to pick out the specifications before using the headset with the phone.

===Installation===
Follow the vendor setup directions for using the headset with a PC but connect the USB plug of the headset to an USB slot of the IP2x2 phone.
There is no need to install any vendor provided PC software.

Some headsets are designed to be connected both to a telephone via DHSG, AEI or a similar protocol and to a PC via USB.
In this case you must also set up the headset for use with a PC, sometimes a special keypress is required to fix this setting.

===Configuration===
An USB headset is detected and automatically enabled as soon as it is connected to one of the phones a USB ports.

Enabling the headset has the following effects:
* a headset icon is displayed in the phone status line
* a normal inbound call is indicated by a ring tone in the headset (if this is supported by the headset)
* an automatically connected inbound call ((announcement, broadcast) is connected to the headset (not to the speaker as usual)
* a call initiated by pressing the ''Redial'' key while browsing a call list or a directory is connected to the headset
* a call initiated by pressing the ''Redial'' in indirect dialling mode is connected to the headset

Before V9hotfix9 it's was necessary to enable the headset explicitely at the telephone either by setting "Menu/Phone Setup/Headset: On" or by a ''Headset'' function key with ''Mode: Enable''. This is obsolete now.

===Call control===
The IP2x2 telephones don't provide a hardware key to control the headset but if required a ''Headset'' function key with ''Mode: Control'' can be defined to setup/accept calls via headset directly on the telephone.
Headset call control can be performed in different ways:
* by the ''Talk'' key on the headsets base station
* by the ''Talk'' key on the headset itself
* by the ''Headset:Control'' function key
* by the ''Redial'' key (outbound calls only)

Some headsets require that all call control is performed by a ''Talk'' key, otherwise the media connection between base and headset gets lost.
Call control by a ''Talk'' key works only if the headset is known to the firmware!

Before V9hotfix9 setting up outbound calls via a ''Talk'' key was disabled and had to be to be enabled via the WEB interface by checking "Phone/Preferences/Start Outbound Call on Electronic Hook Switch (EHS) Signal". This is obsolete now.

====Outbound Calls====
* enter a number and press ''Redial''
* select an entry in a call list or a directory and press ''Redial''
* press a ''Talk'' key and enter the number (if this function is enabled)
* press the ''Headset:Control'' function key and enter the number

To drop the call press a ''Talk'' key, the ''Disconnect'' key or the ''Headset:Control'' function key.

====Inbound Calls====
To accept an inbound call press a ''Talk'' key or the ''Headset:Control'' function key.
To drop the call press a ''Talk'' key, the ''Disconnect'' or the the ''Headset:Control'' function key.

===Headset Volume control===
====Speaker Volume====
Usually the headset provides it's own speaker volume control and this should be preferred.
The phone volume control can be used when the range of the headset volume control is not sufficient.

====Microphone Volume====

Usually there is no need to change the phones default gain for the headset microphone signal.
But there are rare cases where the microphone signal is too strong or even more rarely too weak.
In this cases the gain can be changed by config commands entered in the browser address line:

config add AC-DSP0 HEADSET /InputGain ''gain''
config activate
config write

''gain'' values from 1 to 63 can be configured (1/2 dB steps). A value of 32 means 0dB, lower values mean attenuation, higher values amplification.
The default value is 40 i.e. 8dB amplification.

====Microphone Mute====
Usually the headset provides it's own ''Mute'' button and this should be preferred.
The phones ''Mute'' function is independent of the headset function, i.e. a headset muted via its own button can be unmuted only via this buton but not at the phone.

==Known Problems==
Monitor Mode does not work with USB headsets, i.e. the telephone speaker cannot switched on in addition to the headset.

==Supported Headsets==

===Abbreviations===

PN = Part Number as printed on the package (P/N: or PN: or Part No or ...)

ID = USB procuct id as read from the device (idProduct)

YES = feature tested and fully operational

NO = feature not supported by innovaphone

N/A = device does not provide functionality

===Jabra (GN Netcom)===
Jabra Link 14201-30 (ID 0x0925) connects the headsets DHSG ports with the USB interface of the telephone

====wireless====
====='''GN 9350e (PN 9356-607-401, ID 0x9350)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | NO
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
NO1The media channel between base and headset can be activated/deactivated only by the headset or the base but not by the phone 
End of Sales 30.06.2013, End of Life 30.06.2015 for EMEA und APAC
 

====='''Pro 9450'''=====
Pro 9450 (PN 9450-25-507-101, ID 0x1021) 
Pro 9450 Duo EMA (PN 9450-29-707-101, ID 0x1022) 
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 5
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES 2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 4
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 1
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A 7
|-
|}
 

====='''Pro 9460 (PN 9460-25-707-101, ID 0x1041)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 6
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A 7
|-
|}
 

====='''Pro 9470 (PN 9470-26-904-101, ID 0x1042)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 6
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A 7
|-
|}
 

====='''GO 6470 (PN 6470-15-207-501, ID 0x1003,0x1004, Firmware 4.5.17)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Jabra Link 14201-30 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 4
| style="text-align:center" | N/A 6
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 3
|-
| Call last number dialed (mobile phones and supported softphones only)
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
| style="text-align:center" | N/A 7
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A 7
|-
|}
 

====='''Pro 920 (PN 920-25-508-1)'''=====
connected with '''Jabra Link 14201-30''' to '''DHSG''' port 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
|}
 
====='''Pro 930 (PN 930-25-509-101, ID 0x1016, 0x1017)'''=====
(ID 0x1016 since V9hotfix12, ID 0x1017 since V9hotfix24) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A
|-
|}
 

====='''Pro 935 BT'''=====
PN 935-15-509-201 200614 Version A, ID 0x1037 (Alpha3 - For Evaluation only) 
PN 935-15-509-201 261114 Version A, ID 0x1037 
(since V9hotfix35) 
A double tap on the headset talk button when phone is idle does not work as expected.
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | NO
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | YES 1
|-
|}
 

====='''GO 660 (PN 5078-228-209, ID 0x0320)'''=====
The Jabra GO 660 Bluetooth headset system consists of the Jabra EXTREME™ headset 
and the Jabra LINK 320 USB Bluetooth adapter. 
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 5
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
|-
|}
 

====='''SUPREME UC / MOTION UC'''=====
SUPREME UC (PN 5078-230-310) 
The Jabra SUPREME UC Bluetooth headset system consists of the Jabra SUPREME™ headset (tested firmware version 2.5.2) 
and the Jabra LINK 360 USB Bluetooth adapter, ID 0xa346. 
MOTION UC (PN 6640-906-140) 
The Jabra MOTION UC Bluetooth headset system consists of the Jabra MOTION headset (tested firmware version 1.36.2) 
and the Jabra LINK 360 USB Bluetooth adapter, ID 0xa346 (tested firmware version 1.14.0). 
(since V9hotfix13) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
 

====='''GO 6430 (PN 6430-17-20-201, ID 0xa342, Firmware 5.4.17)'''=====
The Jabra GO 6430 Bluetooth headset system consists of the Jabra GO 6430 headset 
and the Jabra LINK 350 USB Bluetooth adapter. 
(since V9hotfix13) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
| Redial last number dialled
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
 

YES 1 Double Tap 
YES 2 Press (hold 1-2 seconds) 
YES 3 Touch Red Handset Icon 
N/A 4 Double Tap - not supported by DHSG 
N/A 5 Press (hold 1-2 seconds) - not supported by DHSG 
N/A 6 Not transfered to the Phone 
N/A 7 Not available via Touch Screen Menu 

====corded====
====='''BIZ 2300 USB'''=====
BIZ 2300 USB UC Mono (PN 2393-829-109 ID 0x2301) 
(since v10sr6 / v9hotfix32) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Press Flash button when there is a connected and a waiting call 
 

====='''BIZ 2400 USB'''=====
BIZ 2400 USB Mono (PN 2496-829-104, ID 0x2400) 
BIZ 2400 MS USB Mono (PN 2496-823-104, ID 0x2401) 
BIZ 2400 USB Duo (PN 2499-829-104, ID 0x91c) 
BIZ 2400 USB OC (PN 2499-823-104, ID 0x090a) 

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

====='''LINK 280 (PN 280-09, ID 0x0910)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 
====='''Jabra SPEAK 410 / 510'''=====
Jabra SPEAK 510 UC (PN 7510-209, ID 0x0410,0x0412) 
(since V9hotfix24) 
Jabra Speak 510 mit Bluetooth Dongle Link 360 (PN 7510-409 - "refer info from partner") 
Jabra SPEAK 410 (PN 7410-209, ID 0x0420) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

====='''Jabra UC VOICE 550 / 750'''=====
Jabra UC VOICE 550 Mono (PN 5593-829-209, ID 0x0031) 
Jabra UC VOICE 550 Duo (PN 5599-829-209, ID 0x0030) 
(since V9hotfix12) 
Jabra UC VOICE 750 MS Duo (PN 7599-823-109, ID 0x0752) 
(since V9hotfix24) 
'''Please Note''': Headsets with '''Version A''' printed on the package have IDs different to the non-A versions even if the part numbers do not differ. 
Jabra UC VOICE 550 Mono (PN 5593-829-209 02/26/13 Version A, ID 0x034b) 
Jabra UC VOICE 550 Duo (PN 5599-829-209 06/12/13 Version A, ID 0x0349) 
Jabra UC VOICE 550 MS Duo (PN 5599-823-109 02/26/13 Version A - optimized for Lync, ID 0348) 
Jabra UC VOICE 750 Mono Drk (PN 7593-829-409 28/08/13 Version A, ID 034f) 
Jabra UC VOICE 750 MS Duo Drk (PN 7599-823-309 28/08/13 Version A - optimized for Lync, ID 034c) (since v10 SR5 / V9 hotfix 31) 
Jabra UC VOICE 750 MS Duo Drk PN 7599-829-409 29/12/14 Version A (since V10 SR15 / V9 hotfix 41) 
 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

===Plantronics===
Plantronics APU-70 (PN 83 018-01, USB ID 0x0410) connects the EHS port at headset base with the USB port of the telephone

====wireless====
====='''Voyager PRO UC / Legend UC'''=====
Voyager Legend UC (PN 87670-02) 
(since V9hotfix24) 
Voyager PRO UC v2 (PN 38885-02) 
Open phone line on target phone from headset supported since V9hotfix24 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Call back last call
| style="text-align:center" | YES
| style="text-align:center" | NO
| style="text-align:center" | N/A
|-
| Initiate phones voice dialling
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
| Reconnect lost connection
| style="text-align:center" | N/A
| style="text-align:center" | not tested
| style="text-align:center" | N/A
|-
|}
 

====='''Savi W430'''=====
Headset connected via Plantronics D100 USB/Bluetooth adapter (ID 0xab01) 
(since V9hotfix12) 
Attention! Since V9hotfix23 only D100 adapters with a firmware Version greater or equal 0118 will work correctly. 
In case of problems use Plantronics Update Manager to update your D100 adapters to the latest firmware version. 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | NO1
| style="text-align:center" | N/A
|-
|}
 

====='''Savi W440A (PN 83359-02)'''=====
Headset connected via Plantronics D100 USB/Bluetooth adapter (ID 0xab01) 
Attention! Since V9hotfix23 only D100 adapters with a firmware Version greater or equal 0118 will work correctly. 
In case of problems use Plantronics Update Manager to update your D100 adapters to the latest firmware version. 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Flash between calls
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
|}
 

====='''Savi 740 / 745'''=====
Savi 740 (PN 83542-12, ID 0xac01) 
Savi 745 (PN 86507-03, ID 0xac01) 
(since V9hotfix14) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |Plantronics APU-70 to DHSG port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A 1
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | NO 2
| style="text-align:center" | N/A
|-
|}
N/A1 Press volume up or down at least 1,5 seconds (not supported by DHSG) 
NO2 Press volume up or down at least 1,5 seconds (not passed to the phone) 
 

====='''Calisto 620 (PN 86700-02)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Speakerphone'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | NO 1
|-
|}
NO1 Mute button present but did not work on tested sample 
 

====='''Calisto P835 (PN 85335-03)'''=====
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
| Open phone line on target phone
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Answer incoming call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| End current call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Volume
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Mute
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Flash between calls
| style="text-align:center" | not tested
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
|}
 

====corded====
====='''DA 45 / DA45 with EncorePro HW301N'''=====
DA 45 PN 77559-42 ID 0xaa05 
(DA45 Firmware Version 90 supported since V9hotfix24)
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Long press on Talk button when there is a connected and a waiting call 
 

====='''Blackwire C320 / C520'''=====
Blackwire C320 (PN 85619-02, ID 0xc00f) 
(since V9hotfix23) 
Blackwire C520 (PN 88861-01, ID 0xc017) 
(since V9hotfix24) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Long press on Talk button when there is a connected and a waiting call 
 

====='''Blackwire C420 (PN 82632-05 ID 0xaa14)'''=====
(since V9hotfix24)
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Long press on Talk button when there is a connected and a waiting call 
 

====='''Blackwire C435 (PN 85800-05, ID 0xaa12)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 
====='''Blackwire C620 (PN 81965-42 ID 0xaa00)'''=====
(since V9hotfix24)
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES1
|-
|}
YES1 Long press on Talk button when there is a connected and a waiting call 
 

====='''Blackwire C720 (PN 87670-02, ID 0x010a)'''=====
(since V9hotfix23) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Answer incoming call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| End current call
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Volume
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
| Mute
| style="text-align:center" | not tested
| style="text-align:center" | not tested
|-
|}
 

====='''Calisto P420 USB SPEAKERPHONE (PN 82136-02 ID 0xd101)'''=====
(since V9hotfix12) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}
 

===Sennheiser===

Sennheiser CEHS-CI 02 (Prod. Code 504533, ID 0x0925) connects EHS port at headset base with the USB port of the telephone

====wireless====

====='''DW Office (PN 504300, ID 0x740a)'''=====
(since V9hotfix13) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
! align="center" style="background:#f0f0f0;"|'''Base'''
|-
! align="center" style="background:#f0f0f0;"|connected
! align="center" style="background:#f0f0f0;" colspan="3" |CEHS-CI 02 to EHS port
! align="center" style="background:#f0f0f0;" colspan="3" |directly to USB
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES
| style="text-align:center" | N/A
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES 1
| style="text-align:center" | N/A
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
|-
| Redial last number 
| style="text-align:center" | YES
| style="text-align:center" | N/A
| style="text-align:center" | N/A
| style="text-align:center" | YES
| style="text-align:center" | YES 2
| style="text-align:center" | N/A
|-
|}
 
YES1 Long press on Talk button when there is a connected and a waiting call 
YES2 Long press on Talk button when phone is idle 

====='''Presence UC ML, Presence Headset + USB-Bluetooth dongle BTD 800 USB (PN 504575, ID 0x002d)'''=====
(since v10sr6 / v9hotfix32) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Put current call on hold, and accept incoming call
| style="text-align:center" | YES
| style="text-align:center" | NO1
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES2
|-
| Flash between calls
| style="text-align:center" | YES
| style="text-align:center" | YES3
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | YES4
|-
|}
 
NO1 Long press on Talk button (1 sec) is not reported to phone when there is a connected call 
YES2 Long press on Talk button (1 sec) when phone is ringing 
YES3 Double tap on Talk button when there is a connected and a waiting call 
YES3 Double tap on Talk button when phone is idle 
 
 

====corded====

====='''UUSB8 (Art. no. 504004, ID 0x0008)'''=====
(since V9hotfix13) 
{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Mute
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Reject incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES 1
|-
| Redial last number
| style="text-align:center" | YES
| style="text-align:center" | YES 2
|-
|}
 
YES1 Long press on Talk button when phone is ringing 
YES2 Long press on Talk button when phone is idle 
 
 

==Unsupported Headsets==

Sometimes new headsets are relased which are very similar to one of the already supported headsets.
But if the signature (vendor/product) of the headset is unknown to the firmware the call control functions
of the headset are without effect. 
Unsupported corded headsets may be used then as plain audio devices where
call control is solely performed by the phone but wireless headsets usually will not work this way.

If adviced so by support or by the manufacturer such an unsupported headset can be mapped to a supported headset
of similar properties.

vars create KEYS0/HID-MAP p <map>[,<map>]...

maps the new signature to an existing one. '''<map>''' format is

manufacturer:product=manufacturer:product

The second '''manufacturer:product''' tuple is the signature of an already supported headset,
''manufacturer'' and ''product'' are plain 4 digit hex numbers without a "0x" prefix.
More maps can be specified separated by a comma.
 
If there is for example a new Jabra headset with a ID 0xa34a which is very similar to the ''Jabra SUPREME UC'' the map would be

vars create KEYS0/HID-MAP p 0b0e:a34a=0b0e:a346

where ''0b0e'' ist the Jabra ManufacturerId and a346 is the ID of ''Jabra SUPREME UC''

* Another Example how to detect the correct ID:

We know a Jabra Speak 510 with ID 0420 and if the ID of his device is xxxx the correct command would be

vars create KEYS0/HID-MAP p 0b0e:xxxx=0b0e:0420

How to find xxxx? Unplug Headset, Clear trace buffer, Plug Headset, take a trace, look for a line like

USB-DEVICE vendor=0b0e 'Jabra' product=xxxx 'Jabra Speak 510' release=0118

==3rd Party tested Headsets ==
These are reports we received from customers. We provide those "as is" (that is, we did not verify the data and this is in no way a promise that such headsets would work).

{{Template:3rd Party Input}}

=== Jabra speak 510 MS with part number 7510-109 ===

I've tried the Jabra speak 510 MS with part number 7510-109 with the following line

!vars create KEYS0/HID-MAP p 0b0e:0422=0b0e:0420

The result tests

{| border="1" cellspacing="0" cellpadding="10" style="border-collapse:collapse"
! align="center" style="background:#f0f0f0;"|'''Operation'''
! align="center" style="background:#f0f0f0;"|'''Phone'''
! align="center" style="background:#f0f0f0;"|'''Headset'''
|-
| Open phone line on target phone
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Answer incoming call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| End current call
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
| Volume
| style="text-align:center" | YES
| style="text-align:center" | YES
|-
|}

Howto:Firmware Upgrade V7 V8

2014-07-21T14:18:34Z

Tle: /* Known Problems */

==Applies To==
This information applies to

* all V8 capable innovaphone devices



==More Information==

===Problem Details===

===Upgrade and Downgrade===
The upgrading and downgraing procedure for firmware is according to V7 as described in [[Howto:Firmware_Upgrade_V6_V7]].

=== Configuration Changes ===

====PBX Object====
The Object type for a physical PBX is changed from '''Node''' Object to '''PBX''' Object. So now it exists a '''Node''' Object (for the numbering node Tree ) and a '''PBX''' Object (for the PBX Tree).

The '''Ldap Quickdial''' Object is merged with the '''Directory Search''' Object, see
[[Reference8:Administration/PBX/Objects/LDAP Quickdial]]

===Phone Display===
Please keep in mind that the phone ringing display for all innovaphone IP Phones (including the IP72) changes greatly with V8, see [[Reference8:Phone_Ringing_Screen]].

===Known Problems===

==== H323 EFC encoding changed ====
*In V8(starting with V7HF14) H323 EFC encoding is changed as described in the bug note [[Support:DVL-Hotfixes#coding_of_H.323_EFC_wrong]]. It results in not ringing V6,V7 phones, if called by V8 PBX.

Solution: Pre-V8 devices must be updated to recent V6 or V7 version, to be compatible to V8.

In case no update to recent V6 or V7 is possible, following configuration change must be done to the PBX:

config change H323 /fix 0

When a phone register to the PBX the EFC setting(fix 0) is communicated to the phone. All phones in the installation will then use the old EFC encoding. However this is only a work around, the recommended solution is to update the devices to the recent V6 or V7 firmware.

==== IP phones have smaller local phone-book capacity ====
Due to the increased firmware size there is less memory left for the local in-core phone-book on the phones. It is thus limited to 500 entries and will be truncated during upgrade. This should not normally create a problem.

There is an option to run larger local phone-books on a n IP phone. For this, you need to specify the <code>/max xxx</code> option for the FLASHDIR0 module with a value larger than 500 for ''xxx'' (e.g. <code>config add FLASHDIR0 /max 2048</code>). Please note that you need to either add this option ''before'' you upgrade to V8 or you will need to restore the phone-book from a backup after the upgrade (as during upgrade the extraneous entries will be deleted).

This option is merely for migration purposes and its usage is not recommended. It will consume extra runtime memory and may cause problems later on during normal operation.

==== Double registration may not work ====
This problem does not exist any longer when upgrading to the latest V8 version.


==== Incompatibilities between certain Firmware Versions in V7, V8 and V9 ====
There are [[Support:Firmware_v9hotfix3_/_v8hotfix19_/_v7hotfix31_should_not_be_mixed_with_earlier_versions | incompatibilities between newer and older V7, V8 and V9 firmware builds]]. As a result, you should not mix these versions. However, contemporary builds of all these version do not have the problem. It is recommended thus to upgrade all V7 and/or V8 builds to the latest version ''before'' starting the migration.

==== Versions / hotfixes ====
We strongly recommend not to omit a version during a upgrade

I.e. Don't upgrade from v7 directly to V9 or V10

Upgrade only step by step to the next versions highest hotfix.

v7 (latest hotfix) -> v8 (latest hotfix),

v8 (latest hotfix) -> v9 (latest hotfix),

v9 (latest hotfix) -> v10 (latest hotfix)

=== Phone Directories===

* Note when upgrading phones to V8 HF1, directories which were disabled in V7 may appear enabled in V8. This is fixed in V8 HF2

=== Store Phone Config===
Starting with v8 it is possible to store phone configs at the PBX (and not only on the phone as was the case until V7). This function is activated by enabling the checkmark [[Reference8:Administration/PBX/Objects#Object_Properties | Store Phone Config]] at the PBX-User-object.
While migrating from the phone based config to PBX based config, the option [[Reference8:Administration/PBX/Objects#Object_Properties | Discard Config on Phone]] can be used to discard an existing configuration at the phone.
As a result, when migrating your PBX from V7 to V8 the PBX-admin must decide whether the v7-phone-configs are to be discarded or not. The step-by-step procedure would be:
* update PBX to V8
* configure users with ''Store Phone Config'' and/or ''Discard Config on Phone''
* update phones to V8 (only now the config is sent to the PBX)

== End of life==
Due to memory limitations there is no V8 software for the IP3000 and IP3000DD

Also please note that there is no V8 support for IP600, IP1500, IP21, IP400, IP202 and IP200 (the old one, not IP200A, see label on the back).

== Related Articles ==
*[[Howto:Firmware Upgrade V6 V7]]
*[[Support:DVL-Hotfixes#coding of H.323 EFC wrong]]
*[[Support:Firmware v9hotfix3 / v8hotfix19 / v7hotfix31 should not be mixed with earlier versions]]

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

Howto:Firmware Upgrade V7 V8

2014-07-21T14:18:08Z

Tle: /* Versions / hotfixes */

Howto:Firmware Upgrade V9 V10

2014-07-21T14:17:44Z

Tle: /* Versions / hotfixes */

== Applies To ==
This information applies to:


* All PBX devices
* All DECT devices
* Linux Application Platform

== Configuration Changes ==
=== Registrations with H.323 and there is no matching Device ===
According to [[Reference9:PBX/Objects]], registrations must not be possible if there is no matching ''device'' entry in the object. However, up to V9 it was possible to register if the ''H.323 id'' matched with the user entry. Such registrations will not be possible with V10 any more.
=== LLDP is enabled by default ===
From version 10, LLDP is implemented and enabled by default for all the Ethernet interfaces and can be disabled. If a V9 device is connected to a switch that offers VLAN settings via LLDP, then this was ignored in V9 and will be honoured after an upgrade to V10. Unfortunately, this will change the VLAN the device uses and thus may inhibit IP access to the device after the upgrade.

You should disable LLDP before the upgrade thus. If this is not possible, you may connect to the device using the other ETH interface to disable LLDP. If this is not possible either, you need to connect the device to another switch w/o LLDP prior to the upgrade, disable LLDP after the upgrade and then put back the device to the original switch.

== XCapi ==
For some time now we do recommend to use SIP to register an XCapi client with the PBX. For more details, see [[Howto:XCAPI]]. XCapi installations which used to work with pre-V9 PBXs using H.323 may stop working with V10. Changing the registration to SIP however may fail, if the XCapi used is old. You may need to upgrade to a recent XCapi version (pls. refer to XCapi support for details, we have seen version 3.4 work fine).

== Upgrading Linux Application Platform ==

There is no upgrade hotfix/package available, as we have upgraded to the latest Debian distribution and changed other things, which prevent an easy upgrade. So you have to set up a new Linux Application Platform V10 with Reporting V10. 
To keep your configuration and data, perform the following steps:

* Save your Application Platform configuration files (see [[ Reference10:Concept_Linux_Application_Platform#Save_configuration_files.2Fdata | Concept Linux Application Platform]])
* Save your Reporting configuration and data (see [[ Reference10:Concept_Reporting#Backup_and_Restore | Concept Reporting]])
* Save your files from your Linux Application Platform webdav folder
* Install the current Linux Application Platform V10
* Install V10 Reporting and further applications, if needed
* Restore the saved configurations and data (see [[ Reference10:Concept_Linux_Application_Platform#Restore_configuration_files.2Fdata | Concept Linux Application Platform]])
* Copy your webdav files to the new webdav folder
* Reconfigure relay hosts under Administration->Relay Hosts (formerly known as SMTP Relay)

=== Reporting Replication ===
* Perform the above steps for the standby server too
* disable replication on master and standby afterwards!
* reconfigure replication on master and standby

=== Upgrading from beta/rc? ===
Sorry, you have to perform the steps from above too! And you can't restore faxserver/exchange configuration/data files. You'll have to configure the servers again!

==Known Problems==
=== myPBX ===
Mixed V9 V10 myPBX chat conversations (as may occur when a large multi-slave site is upgraded step by step) are not supported.

myPBX needs a license in v10.

=== Versions / hotfixes ===
We strongly recommend not to omit a version during a upgrade

I.e. Don't upgrade from v7 directly to V9 or V10

Upgrade only step by step to the next versions highest hotfix.

v7 (latest hotfix) -> v8 (latest hotfix),

v8 (latest hotfix) -> v9 (latest hotfix),

v9 (latest hotfix) -> v10 (latest hotfix)

=== Old Phone Models ===
Some of the older phone models (namely IP110, IP150, IP200A and IP240) are not capable of running the complete V10 firmware due to memory restrictions. There are a few firmware versions with limited feature set available which still run on those models:

{| border="1"
|-
| '''FW-name '''
| '''Display* '''
| '''SIP'''
| '''H.323'''
| '''PPP'''
| '''Video '''
| '''Note '''
|-
| ipxxx
|
| no
| yes
| yes
| yes
| no SIP
|-
| ipxxx-sip
| ps
| yes
| no
| yes
| yes
| no H.323
|-
| ipxxx-no-ppp
| hs
| yes
| yes
| no
| yes
| no PPP
|}

''xxx'' stands for the phone model (110, 150, 200A, 240). 
''*'' Abbreviation displayed in the ''General/Info'' screen next to the version-number

So if you do not need SIP on the phones, you can still use the normal firmware file (e.g. ''ip110.bin''). However, if you need SIP, you need to decide on which feature to drop and use the respective firmware file variation. This may have some effect on your update scripts.

== Related Articles ==
*[[Howto:Guideline V5 to V6 upgrade]]
*[[Howto:Upgrade Issues V5 to V6]]
*[[Howto:Firmware Upgrade V6 V7]]
*[[Howto:Firmware Upgrade V7 V8]]
*[[Howto:Firmware Upgrade V8 V9]]

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

Howto:Firmware Upgrade V8 V9

2014-07-21T14:17:07Z

Tle: /* Known Problems */

== Applies To ==
This information applies to:


* All PBX devices
* All DECT devices


== Configuration Changes ==

=== PBX Objects ===
Existing '''Broadcast Conference''' objects must be changed with the update to V9 Final '''till V9 Hotfix 6''' if an innovaphone [[Reference:Administration/Gateway/Interfaces#Conferencing_interface_.28CONF.29|Conferencing Interface (CONF)]] is used. Add the 'Conference Id Prefix' '*3' in all BC Conference objects, see also
[[Reference:Administration/Gateway/Interfaces#Conferencing_interface_.28CONF.29|Conferencing Interface]]. With V9 Hotfix 7 and later a predefined id prefix and suffix are used and nothing must be changed if the innovaphone Conferencing Interface is used. With '''V9 Hofix 7 and later''' the '''3rd Party Conferencing Unit''' option in the Broadcast Conference objects must be ticked again if a third party conference unit is used.

==Known Problems==

=== H.323 pickup execute encoding changed ===
If you use V8 DECT devices, the internal DECT feature code 'Pickup' is not correct working with a V9 PBX. The call is not connected, but the device is called back by the PBX.

Workaround: Update the DECT device to V9, use the PBX object DTMF features or use the call pickup with call back.

=== innovaphone voicemail===
Mailboxes with vowel mutation (umlaute/umlauts), like ü,ö,ä (for example Müller, more precisely mailboxes for users with non-ascii characters in the name) did work anymore when upgrading from pre-V9 versions to early V9 development versions. This has been fixed from build 90423. Pre-V9

=== licenses with certain characters in license comment===
See [[Support:V8_to_V9_update_with_license_comments_with_certain-characters|V8 to V9 update with license comments with certain-characters]].

=== Config Templates chained ===
Since there were changes on mechanism from v8 to v9, if there is a complex scenario with chained templates (3 or more) some configurations (ie. function keys) of "upper" templates are lost so it's needed to rework manually this "chains" on v9 setup setting the full "tree" of chained templates (up to 4) plus the checkmark of store-phone config in each template.

=== Incompatibilities between certain Firmware Versions in V7, V8 and V9 ===
There are [[Support:Firmware_v9hotfix3_/_v8hotfix19_/_v7hotfix31_should_not_be_mixed_with_earlier_versions | incompatibilities between newer and older V7, V8 and V9 firmware builds]]. As a result, you should not mix these versions. However, contemporary builds of all these version do not have the problem. It is recommended thus to upgrade all V7 and/or V8 builds to the latest version ''before'' starting the migration.

=== DHCP Lease Reservations with Umlaut-Characters ===
Non-ascii characters in DHCP lease reservations create problems after the upgrade. It is best to remove all such characters before saving the old (pre-V9) configuration.

=== Versions / hotfixes ===
We strongly recommend not to omit a version during a upgrade

I.e. Don't upgrade from v7 directly to V9 or V10

Upgrade only step by step to the next versions highest hotfix.

v7 (latest hotfix) -> v8 (latest hotfix),

v8 (latest hotfix) -> v9 (latest hotfix),

v9 (latest hotfix) -> v10 (latest hotfix)

== Related Articles ==
*[[Howto:Firmware Upgrade V6 V7]]
*[[Howto:Firmware Upgrade V7 V8]]
*[[Support:Firmware v9hotfix3 / v8hotfix19 / v7hotfix31 should not be mixed with earlier versions]]

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

Howto:Firmware Upgrade V7 V8

2014-07-21T14:15:33Z

Tle: /* Known Problems */

==Applies To==
This information applies to

* all V8 capable innovaphone devices



==More Information==

===Problem Details===

===Upgrade and Downgrade===
The upgrading and downgraing procedure for firmware is according to V7 as described in [[Howto:Firmware_Upgrade_V6_V7]].

=== Configuration Changes ===

====PBX Object====
The Object type for a physical PBX is changed from '''Node''' Object to '''PBX''' Object. So now it exists a '''Node''' Object (for the numbering node Tree ) and a '''PBX''' Object (for the PBX Tree).

The '''Ldap Quickdial''' Object is merged with the '''Directory Search''' Object, see
[[Reference8:Administration/PBX/Objects/LDAP Quickdial]]

===Phone Display===
Please keep in mind that the phone ringing display for all innovaphone IP Phones (including the IP72) changes greatly with V8, see [[Reference8:Phone_Ringing_Screen]].

===Known Problems===

==== H323 EFC encoding changed ====
*In V8(starting with V7HF14) H323 EFC encoding is changed as described in the bug note [[Support:DVL-Hotfixes#coding_of_H.323_EFC_wrong]]. It results in not ringing V6,V7 phones, if called by V8 PBX.

Solution: Pre-V8 devices must be updated to recent V6 or V7 version, to be compatible to V8.

In case no update to recent V6 or V7 is possible, following configuration change must be done to the PBX:

config change H323 /fix 0

When a phone register to the PBX the EFC setting(fix 0) is communicated to the phone. All phones in the installation will then use the old EFC encoding. However this is only a work around, the recommended solution is to update the devices to the recent V6 or V7 firmware.

==== IP phones have smaller local phone-book capacity ====
Due to the increased firmware size there is less memory left for the local in-core phone-book on the phones. It is thus limited to 500 entries and will be truncated during upgrade. This should not normally create a problem.

There is an option to run larger local phone-books on a n IP phone. For this, you need to specify the <code>/max xxx</code> option for the FLASHDIR0 module with a value larger than 500 for ''xxx'' (e.g. <code>config add FLASHDIR0 /max 2048</code>). Please note that you need to either add this option ''before'' you upgrade to V8 or you will need to restore the phone-book from a backup after the upgrade (as during upgrade the extraneous entries will be deleted).

This option is merely for migration purposes and its usage is not recommended. It will consume extra runtime memory and may cause problems later on during normal operation.

==== Double registration may not work ====
This problem does not exist any longer when upgrading to the latest V8 version.


==== Incompatibilities between certain Firmware Versions in V7, V8 and V9 ====
There are [[Support:Firmware_v9hotfix3_/_v8hotfix19_/_v7hotfix31_should_not_be_mixed_with_earlier_versions | incompatibilities between newer and older V7, V8 and V9 firmware builds]]. As a result, you should not mix these versions. However, contemporary builds of all these version do not have the problem. It is recommended thus to upgrade all V7 and/or V8 builds to the latest version ''before'' starting the migration.

==== Versions / hotfixes ====
We strongly recommend not to omit a version during a upgrade

I.e. Don't upgrade from v7 directly to V9 or V10

Upgrade only step by step to the next versions highest hotfix.

V7 (latest hotfix) -> v8 (latest hotfix),

v8 (latest hotfix) -> v9 (latest hotfix),

v9 (latest hotfix) -> v10 (latest hotfix)

=== Phone Directories===

* Note when upgrading phones to V8 HF1, directories which were disabled in V7 may appear enabled in V8. This is fixed in V8 HF2

=== Store Phone Config===
Starting with v8 it is possible to store phone configs at the PBX (and not only on the phone as was the case until V7). This function is activated by enabling the checkmark [[Reference8:Administration/PBX/Objects#Object_Properties | Store Phone Config]] at the PBX-User-object.
While migrating from the phone based config to PBX based config, the option [[Reference8:Administration/PBX/Objects#Object_Properties | Discard Config on Phone]] can be used to discard an existing configuration at the phone.
As a result, when migrating your PBX from V7 to V8 the PBX-admin must decide whether the v7-phone-configs are to be discarded or not. The step-by-step procedure would be:
* update PBX to V8
* configure users with ''Store Phone Config'' and/or ''Discard Config on Phone''
* update phones to V8 (only now the config is sent to the PBX)

== End of life==
Due to memory limitations there is no V8 software for the IP3000 and IP3000DD

Also please note that there is no V8 support for IP600, IP1500, IP21, IP400, IP202 and IP200 (the old one, not IP200A, see label on the back).

== Related Articles ==
*[[Howto:Firmware Upgrade V6 V7]]
*[[Support:DVL-Hotfixes#coding of H.323 EFC wrong]]
*[[Support:Firmware v9hotfix3 / v8hotfix19 / v7hotfix31 should not be mixed with earlier versions]]

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

Howto:Firmware Upgrade V9 V10

2014-07-21T14:14:36Z

Tle: /* myPBX */

== Applies To ==
This information applies to:


* All PBX devices
* All DECT devices
* Linux Application Platform

== Configuration Changes ==
=== Registrations with H.323 and there is no matching Device ===
According to [[Reference9:PBX/Objects]], registrations must not be possible if there is no matching ''device'' entry in the object. However, up to V9 it was possible to register if the ''H.323 id'' matched with the user entry. Such registrations will not be possible with V10 any more.
=== LLDP is enabled by default ===
From version 10, LLDP is implemented and enabled by default for all the Ethernet interfaces and can be disabled. If a V9 device is connected to a switch that offers VLAN settings via LLDP, then this was ignored in V9 and will be honoured after an upgrade to V10. Unfortunately, this will change the VLAN the device uses and thus may inhibit IP access to the device after the upgrade.

You should disable LLDP before the upgrade thus. If this is not possible, you may connect to the device using the other ETH interface to disable LLDP. If this is not possible either, you need to connect the device to another switch w/o LLDP prior to the upgrade, disable LLDP after the upgrade and then put back the device to the original switch.

== XCapi ==
For some time now we do recommend to use SIP to register an XCapi client with the PBX. For more details, see [[Howto:XCAPI]]. XCapi installations which used to work with pre-V9 PBXs using H.323 may stop working with V10. Changing the registration to SIP however may fail, if the XCapi used is old. You may need to upgrade to a recent XCapi version (pls. refer to XCapi support for details, we have seen version 3.4 work fine).

== Upgrading Linux Application Platform ==

There is no upgrade hotfix/package available, as we have upgraded to the latest Debian distribution and changed other things, which prevent an easy upgrade. So you have to set up a new Linux Application Platform V10 with Reporting V10. 
To keep your configuration and data, perform the following steps:

* Save your Application Platform configuration files (see [[ Reference10:Concept_Linux_Application_Platform#Save_configuration_files.2Fdata | Concept Linux Application Platform]])
* Save your Reporting configuration and data (see [[ Reference10:Concept_Reporting#Backup_and_Restore | Concept Reporting]])
* Save your files from your Linux Application Platform webdav folder
* Install the current Linux Application Platform V10
* Install V10 Reporting and further applications, if needed
* Restore the saved configurations and data (see [[ Reference10:Concept_Linux_Application_Platform#Restore_configuration_files.2Fdata | Concept Linux Application Platform]])
* Copy your webdav files to the new webdav folder
* Reconfigure relay hosts under Administration->Relay Hosts (formerly known as SMTP Relay)

=== Reporting Replication ===
* Perform the above steps for the standby server too
* disable replication on master and standby afterwards!
* reconfigure replication on master and standby

=== Upgrading from beta/rc? ===
Sorry, you have to perform the steps from above too! And you can't restore faxserver/exchange configuration/data files. You'll have to configure the servers again!

==Known Problems==
=== myPBX ===
Mixed V9 V10 myPBX chat conversations (as may occur when a large multi-slave site is upgraded step by step) are not supported.

myPBX needs a license in v10.

=== Versions / hotfixes ===
We strongly recommend not to omit a version during a upgrade

I.e. Don't upgrade from v7 directly to V9 or V10

Upgrade only step by step to the next versions highest hotfix.

V7 (latest hotfix) -> v8 (latest hotfix),

v8 (latest hotfix) -> v9 (latest hotfix),

v9 (latest hotfix) -> v10 (latest hotfix)

=== Old Phone Models ===
Some of the older phone models (namely IP110, IP150, IP200A and IP240) are not capable of running the complete V10 firmware due to memory restrictions. There are a few firmware versions with limited feature set available which still run on those models:

{| border="1"
|-
| '''FW-name '''
| '''Display* '''
| '''SIP'''
| '''H.323'''
| '''PPP'''
| '''Video '''
| '''Note '''
|-
| ipxxx
|
| no
| yes
| yes
| yes
| no SIP
|-
| ipxxx-sip
| ps
| yes
| no
| yes
| yes
| no H.323
|-
| ipxxx-no-ppp
| hs
| yes
| yes
| no
| yes
| no PPP
|}

''xxx'' stands for the phone model (110, 150, 200A, 240). 
''*'' Abbreviation displayed in the ''General/Info'' screen next to the version-number

So if you do not need SIP on the phones, you can still use the normal firmware file (e.g. ''ip110.bin''). However, if you need SIP, you need to decide on which feature to drop and use the respective firmware file variation. This may have some effect on your update scripts.

== Related Articles ==
*[[Howto:Guideline V5 to V6 upgrade]]
*[[Howto:Upgrade Issues V5 to V6]]
*[[Howto:Firmware Upgrade V6 V7]]
*[[Howto:Firmware Upgrade V7 V8]]
*[[Howto:Firmware Upgrade V8 V9]]

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

Howto:EEE Energy Efficient Ethernet

2014-07-16T14:29:00Z

Tle:

Ethernet link goes occasionally down when using internal switch of phones.

== Applies To ==
This information applies to

* all innovaphone phones with internal switch
* V9 hotfix 33 and V10 SR6 and above (option in webgui to disable EEE)



== Problem ==
To save power, all innovaphone phones have EEE enabled by default .

If supported by the switch, this will reduce energy consumption when there is no network traffic. Normally, you will notice no difference in your daily work, neither on the phone nor on a device (e.g. PC) connected to the phone's internal switch port.

However, some switches do not support EEE properly. In such cases, you will notice spurious ''link down'' messages (e.g. in the windows ''network adapter status bubble''). Also, some applications such as ''terminal server clients'' may drop their server connection due to the ''link down'' event.

It is possible to disable EEE on the phone thus:

[[Image:eee_disabled.png]]

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

Howto:EEE Energy Efficient Ethernet

2014-07-16T14:18:19Z

Tle:

Ethernet link goes occasionally down when using internal switch of phones.

== Applies To ==
This information applies to

* all innovaphone phones with internal switch

* V9 and above

* V9 hotfix 33 and V10 SR6 and above (option in webgui to disable EEE)



== Problem ==
To save power all innovaphone phones have EEE per default enabled.

Usually you notice nothing in your daily work. Also if you use the internal switch of the phone.

With one exception. Thin Client Users can loose there connection to the terminal server.
For this case we implement from V9 hotfix 33 and V10 SR 6 an option to disable EEE - Energy Efficient Ethernet.

[[Image:eee_disabled.png]]

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

Howto:EEE Energy Efficient Ethernet

2014-07-16T14:16:54Z

Tle: New page: Ethernet link goes occasionally down when using internal switch of phones. == Applies To == This information applies to * all innovaphone phones with internal switch * V9 and above * V...

Ethernet link goes occasionally down when using internal switch of phones.

== Applies To ==
This information applies to

* all innovaphone phones with internal switch

* V9 and above

* V9 hotfix 33 and V10 SR6 and above (option in webgui to disable EEE)



== Problem ==
To save power all innovaphone phones have EEE per default enabled
Usually you notice nothing in your daily work. Also if you use the internal switch of the phone.

With one exception. Thin Client Users can loose there connection to the terminal server.
For this case we implement from V9 hotfix 33 and V10 SR 6 an option to disable EEE - Energy Efficient Ethernet.

[[Image:eee_disabled.png]]

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

File:Eee disabled.png

2014-07-16T14:16:01Z

Tle:

Howto:Innovaphone conferencing

2014-06-12T14:33:10Z

Tle:

innovaphone conferencing is a nice sample solution to enhance the conference bridge available on the innovaphone gateways (so-called “BC Conference”).

Installing innovaphone conferencing you will have the following conferencing features:

* Users are announced with name when joining and leaving the conference room.
* The conference room can be labelled; before entering in the room the user will hear the name of the conference.
* Before entering in the room the names of the member’s already in are prompted.
* innovaphone conferencing stores all recorded names for further access; you have to record your name just one time.

==Applies To==
This information applies to

innovaphone PBX with DSP channels for conferencing
developed with V9 build 90267



==More Information==

innovaphone conferencing allows you to setup a very comfortable audio conference.

If a number calls the innovaphone conferencing for the first time the system asks, after playing the welcome message, to record a name.

The recording can be done immediately, just following the voice menu (“Please record your name, start recording with star and stop with any key”). After recording, the recorded name is played again. The record can be modify in any moment and anyway before entering in the conference room.

If the same number calls the innovaphone conferencing system again, the system will not ask to record the name but welcome the caller, with the previously recorded name. So once recorded, innovaphone conferencing stores the names for the calling number.

If the conference room is still empty, the system asks you to label the conference room. This is done via a voice menu invitation to record the name of the conference, even this recording can be modified later on. However if the conference room is already named, the caller is not invited automatically to label the room but the name of the conference if played.

[[Image:Conf01.png]]

If you don’t like give a name to a conference room just press quickly “*#” when the recording of the name is requested (practically you record nothing and therefore the system will prompt “… in the conference, press star to join ….”).

The following example shows a call to the innovaphone conferencing, where the NAME and the LABEL was already recorded:

“innovaphone conferencing, welcome MARTIN STRELLER to SALES conference room”

After this introduction the main access menu is played:

“Press star to join the conference room, press one to record your name or press two to label the conference room”

From this menu the caller can record again his name or label the conference room. The star-key allows the access to the conference room.
If the conference unit is not reachable (configuration or network problems) or no conference channel is available (all available DSPs are used), a warning message is played.

If the caller is the first member, he will hear “You are the first conference member”. If there are already members in the conference room, he will hear their names.

Example:

“In the conference room you will find ANDREAS FINK, KLAUS WALLNÖFER”

After playing the list of the conference members, the caller access the conference room and all the members hear a warning ton (“beep”) followed by the name of the new entry.

Example:

“MARTIN STRELLER joined the conference”

If a conference member exits from the conference room, the remaining members will hear a warning tone followed by the name of who has left.

Example:

“ANDREAS FINK leaves the conference”

When the last user leaves the conference room, the room label will be automatically cleared.

===Configuration===

Download the xml and wave files, copy them on a directory of your PC and unzip the folder.
Create a directory on the compact flash (CF) card and copy all files in. Now you have to create or certify the following empty sub directories exist:
“names”
“member”
“leave”
“join”

Once done you will see the following directory structure (show in the Datafreeway explorer):

[[Image:IC05.png]]

The remaining setup has to be done in the PBX.

First configure a BC Conference object. Leave all items to their default settings, except the one specified. Basically the BC Conference object doesn’t need a number because the access to it will be trough a XML script and names.

[[Image:IC03.png]]

Therefore it is important that the ''Name'' of the BC conference object is “innoconf”, the ''Description'' and ''Long name'' are not important.
The ''Display Name'' should be nice, because if the user is in the conference room, he will see this name on the display (while he is in the menu “outside” the conference room, he will see the display name of the XML, so even from a display point of view the user knows exactly “where he is”).

Please note the required setup in the third tab:

[[Image:bc-conference-config.png]]

Now assign in the main PBX menu a new group to the the BC conference object and flag the group as “active”. In the following example we call the group “CallBC”:

[[Image:IC06.png]]

Now you have to create two voicemail objects. No voicemail license is required for this.
Create the first one and name it as you like. No number is required since this XML is never shown anywhere.
Important: Set the codec option as shown in the following example to $_pbxcoder=g729.
In our example, we created a directory called “innoConf” on the CF card. The XML file name is “innoconfB.xml”:

[[Image:IC01.png]]

Now put the voicemail object executing the “innoconfB.xml” file in the same group than the BC conference object, but NOT as an active member.

Last step: create the second voicemail object. The number of that object is the “innovaphone conferencing” number and the ''Display Name'' of this object will be shown to the user calling the innovaphone conferencing. A good example is “conference access” or a similar name.
Important: Add the flag “$_pbxfwd=true” to the URL of the voicemail object. The name of the xml file is “innoconfA.xml” (in the example in the directory “innoConf”).

[[Image:IC02.png]]

===Static conference room name===
Some time or some customer has more or less always the same conference name and not interested in labeling (or “naming”) a conference room. If this is your case here is how avoid that in each new conference the name has to be record again. To activate that option you have to edit the file named innconfB.xml. To do that copy the file first from the CF to the PC, modify it, and then copy it back again (in other words: it is not a good idea edit directly on the CF). Open the file with the editor and you will see something like that:

[[Image:NoConfName.png]]

If you delete the indicated line the name of the conference room will not be cleared if the last user exit the conference unit and therefore if the conference is called again, the name of the conference is still there and the user will not here “please label your conference” but go directly to the main menu (where he can still doing that).

===Localization===
The innovaphone conferencing is delivered with professional prompts recorded by [[Howto:Voice_Prompts_-_GM_Voices%2C_Inc._-_3rd_Party_Product|the voice recording company GM Voices]].

The prompts are provided in 11 languages.

If your preferred language is not available, it is very simple to create prompts in other languages. You have just to translate the following prompts:

Filename (containing prompts in English)

Welcome ("innovaphone conferencing")

ConfName ("Please label your conference room")

RecStart ("Start recording with star and stop with any key")

To ("to")

UserWelcome ("welcome")

Conference ("conference room")

MyName ("Please record your name")

FirstUser ("You are the first conference member")

Join ("joined the conference")

Leave ("leaves the conference")

InTheConf ("in the conference room you will find")

MMenu ("press star to join the conference room, press one to record your name or press two to label the conference room")

noconf ("There is no conference channel available")

After recording, do the post processing (see relative wiki articles) and convert the file format to 8 kHz, 16 bit mono. Finally, convert the wav files to the .g729 and .g711A format (using the [[Howto:Convert_wave_files_to_G7xxx_with_softcod | softcod utility]] or by using the [[Howto:How_to_convert_wave_files_in_to_G7xx_coder_files_for_the_HTTP_interface#V6_SR1_note | conversion function of the CF card]]).
One hint: When the conference room is labelled, the engine will prompt “to” + “conference room” + the name.

===Multiple conference rooms===

Innovaphone conferencing is done to give the customer one enhanced conference room on one system. If a customer asks for parallel and independent innovaphone conferencing rooms on the same system, please follow this instructions.
First you have to configure as many BC conferences objects in the PBX, as separate conference rooms by the customer. Each BC conferences object has its own name and groups. Then create for each room a different directory on the compact flash card. Next create the required pairs of voicemail objects. You have to edit the “innoconfA.xml” file (use a simple text editor). We recommend editing the file on your PC and then copying it on the CF card. Finally, ou have to modify the name of the BC conference object:

[[Image:IC07.png]]

If for example you named the second BC conference object “mySecondOne” you have to modify the line from:
<pbx-fwd name=" innoconf " barge-in="false" out-cause="$cause"/>
to:
<pbx-fwd name=" mySecondOne " barge-in="false" out-cause="$cause"/>

===Known Problems===
* No support at the moment for unknown callers (without number - CLIR activated).
* If in the same time two user access the innovaphone conferencing system and the room is empty - both will hear “You are the first conference member”. However once in the conference, both names will be announced.
*There is a small delay between the real enter and exit of a user and the announcement (between 0-4 seconds). This is done to avoid too much load for CF card and CPU.
* On multiple conference rooms on the same system, for each room you have to record your name again.

*When a member leave the conference room, and the remaining members may not hear the warning tone followed by the name of who has left. This issue had been fixed already, so use the latest version of the XML script (see [[#Download]]).

== Related Articles ==
[[Howto:Creating_fine_announcements_and_music_on_hold|Howto:Creating fine announcements and music on_hold]]

[[Howto:Installing_the_voicemail/music_on_hold_on_a_compact_flash_card|Installing the voicemail/music on hold on a compact flash card]]

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



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

Howto:General information for compact flash cards

2014-04-16T15:23:55Z

Tle: /* Known Problems */

==Applies To==
This information applies to

* IP 6000, V6 SR1
* IP 800, V6 SR1
* IP 302/305, V6 SR1

==More Information==

; Which size should the card have? : The card should have at least 64 MB, because it uses FAT32. Cards with up to 32GB were tested successfully.

; Is there a formula to calculate the space for one mail box user? : Assuming we have G.711, a voice mail (120 seconds maximum) has 960 kByte, because 8 kByte/s are used and assuming we have G.729, a voice mail has 120 kByte, because 1 kByte/s is used.
So it's now on you to estimate the amount of voice mails one of your users will have and how many voice mail users you have.

; Is there a recommended card speed? : Yes, especially if you run Linux Application Platform on IPxx10, we recommend a CF card with at least 90 MB/s, e.g. SanDisk Extreme PRO. For all other purposes on Gateway without Linux support, a SanDisk Ultra with 30MB/s will do.

; Are there recommended manufacturers/cards? : Yes. We recommend to use SanDisk cards, because we made the best experiences with them. But in general, each card should be supported. For SanDisk cards, please use Extreme or Extreme PRO.

; Is it possible to put MOH on the compact flash card? : Yes, this is possible.

; How about wear leveling on the Compact Flash cards? What are you doing in that regard? : Wear leveling is done by compact flash card hardware. Please keep in mind: the more free space do you have on the card the better wear leveling works. SanDisk cards are known to have very good wear leveling performance.

; Are there further requirements when the LinuxAP is used?
Yes, see [[Reference10:Concept_Linux_Application_Platform#IPxx10_Gateways | CF-Card Requirements for LinuxAP ]]

===Known Problems===

; Old gateways : Older revisions of the IP6000 have problems with certain CF card manufacturers. Please use the recommended Sandisk cards here. Revisions since hardware 300 do not have this issue any more.
; Missing DMA support: Old CF Cards does not support DMA, the IP6000/IP800 did not need the DMA. If you use an IP6010 than you need CF Cards with DMA. When you use an IP6010 with old CF Cards, and the card is not working please start an trace than you see <code>NO DMA mode Supported NO Valid CF-Card</code> If you see this message in the trace please replace the CF card.

; CF-Cards and ESD : CF cards have typically a metal coated surface. It's possible that electrostatic discharge (ESD) flow through this interface and disturb a device. In general compact flash cards are sensitive to ESD and can be damaged. To prevent ESD damage, you can use a ESD wrist or ankle strap.

== Related Articles ==

* [[Howto:Installing_the_voicemail/music_on_hold_on_a_compact_flash_card | Installing the voicemail/music on hold on a compact flash card]]
* [[Reference10:Concept_Linux_Application_Platform#IPxx10_Gateways | CF-Card Requirements for LinuxAP ]]

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

Reference10:Interfaces/FXO/Signaling

2014-04-07T13:33:12Z

Tle:

The call '''signalling''' settings of the analogue FXO interfaces can be made here:

{|
|valign=top nowrap=true|'''Disable:'''
| Disables the relevant analogue FXO interface.
|-
|valign=top nowrap=true|'''Speech Bearer Capability:'''
|Calls on the relevant interface are transmitted with Audio Bearer Capability as standard. A checked check box transmits calls from the relevant interface with Speech Bearer Capability. This only makes sense if only telephones are operated on the relevant interface (no fax machine or modem).
|-
|valign=top nowrap=true|'''Central Office Tone detection:'''
|When the FXO initiates a call, normally a audible tone is expected to be received from the central office/local PABX side. The tone detection works independantly from any country setting. When the expected tone cannot be detected within 2.6sec, then the call will be cancelled. If this tone detection is disabled, the FXO will continue dialing DTMF tones of the configured number, with a fixed delay of 800ms after hook-off.
|-
|valign=top nowrap=true|'''Alert Tone detection:'''
|After the configured number has been dialed, the FXO normally waits for a audible response from the dialed side that can be identified as an alerting tone. The proper detection and analysis of this tone takes up to a few seconds. If you additionally enable the '''Assume alert''' option, the detection is simplified and therefore reduced to a simple tone detection. This means that an alert will be regarded as detected na matter what tone or rhythm is provided. This is much faster than the exact analysis and normally has no negative effect. When an alert is detected, the voip>-FXO->peer connection is switched through (connected), so that the voip initiator of the call now can hear the alerting tone from peer side. Disabling '''Alert Tone detection''' will directly connect the call after dialing is complete, which is much faster.
|-
|valign=top nowrap=true|'''Assume Alert:'''
|see previous topic for details. '''Assume Alert''' has no effect when '''Alert Tone detection''' is disabled.
|-
|valign=top nowrap=true|'''Drop line on polarity reversal:'''
|When the FXO port detects a reversed polarity, the current connection will be terminated. Polarity reversals must must be longer than 100ms to be detecable.
|-
|valign=top nowrap=true|'''CallerID 1 standard:'''
|Selects the standard in which CallerID (also known as '''CLIP''') is detected and decoded. What is of interest here is the caller's phone number in case of an incoming/ringing call. This number is fed into the resulting voip call as the CGPN (Calling Party Number). Note that for this reason the FXO port has to be registerd to the PBX as '''gateway''', and has to be configured with '''Force enblock''' in the ''Gateway->Routes'' Menu. You can change the value of 4000ms to shorter values, but the time must be enough to collect the digits of the longest possible number. This heavily depends on the typical number length - estimate 135ms for each DTMF digit + 1300ms overhead + duration of the first ring pulse. 4000ms will cover 18 DTMF digits if the first ring pulse is very short. Note that for most countries 2 invisible digits are added.
This delay time is normally used if no CallerID can be detected at all. However, if FSK or DTMF digits are detected, this time will normally reduce drastically. The voip call then starts with this short delay in which the CallerID/CLIP information is received. 
The FSK standards can contain additional information like ''Called Line Id'' or ''Date/Time'' information. These additional informations will be dropped. DTMF callerID only contains the 'Calling Line Id'.
|}

Reference10:Interfaces/FXO/Signaling

2014-04-07T13:30:09Z

Tle:

The call '''signalling''' settings of the analogue FXO interfaces can be made here:

{|
|valign=top nowrap=true|'''Disable:'''
| Disables the relevant analogue FXO interface.
|-
|valign=top nowrap=true|'''Speech Bearer Capability:'''
|Calls on the relevant interface are transmitted with Audio Bearer Capability as standard. A checked check box transmits calls from the relevant interface with Speech Bearer Capability. This only makes sense if only telephones are operated on the relevant interface (no fax machine or modem).
|-
|valign=top nowrap=true|'''Central Office Tone detection:'''
|When the FXO initiates a call, normally a audible tone is expected to be received from the central office/local PABX side. The tone detection works independantly from any country setting. When the expected tone cannot be detected within 2.6sec, then the call will be cancelled. If this tone detection is disabled, the FXO will continue dialing DTMF tones of the configured number, with a fixed delay of 800ms after hook-off.
|-
|valign=top nowrap=true|'''Alert Tone detection:'''
|After the configured number has been dialed, the FXO normally waits for a audible response from the dialed side that can be identified as an alerting tone. The proper detection and analysis of this tone takes up to a few seconds. If you additionally enable the '''Assume alert''' option, the detection is simplified and therefore reduced to a simple tone detection. This means that an alert will be regarded as detected na matter what tone or rhythm is provided. This is much faster than the exact analysis and normally has no negative effect. When an alert is detected, the voip>-FXO->peer connection is switched through (connected), so that the voip initiator of the call now can hear the alerting tone from peer side. Disabling '''Alert Tone detection''' will directly connect the call after dialing is complete, which is much faster.
|-
|valign=top nowrap=true|'''Assume Alert:'''
|see previous topic for details. '''Assume Alert''' has no effect when '''Alert Tone detection''' is disabled.
|-
|valign=top nowrap=true|'''Drop line on polarity reversal:'''
|When the FXO port detects a reversed polarity, the current connection will be terminated. Polarity reversals must must be longer than 100ms to be detecable.
|-
|valign=top nowrap=true|'''CallerID 1 standard:'''
|Selects the standard in which CallerID (also known as '''CLIP''') is detected and decoded. What is of interest here is the caller's phone number in case of an incoming/ringing call. This number is fed into the resulting voip call as the CGPN (Calling Party Number). Note that for this reason the FXO port has to be registerd to the PBX as '''gateway''', and has to be configured with '''Force enblock''' in the ''Gateway->Routes'' Menu. You can change the value of 4000ms to shorter values, but the time must be enough to collect the digits of the longest possible number. This heavily depends on the typical number length - estimate 135ms for each DTMF digit + 1300ms overhead + duration of the first ring pulse. 4000ms will cover 18 DTMF digits if the first ring pulse is very short. Note that for most countries 2 invisible digits are added.
This delay time is normally used if no CallerID can be detected at all. However, if FSK or DTMF digits are detected, this time will normally reduce drastically. The voip call then starts with this short delay in which the CallerID/CLIP information is received. 
The FSK standards can contain additional information like ''Called Line Id'' or ''Date/Time'' information. These additional informations will be dropped. DTMF callerID only contains the 'Calling Line Id'.
|}

Reference9:Concept Operator

2014-03-20T14:10:50Z

Tle: /* Known Issues */

[[Category:Concept9|{{PAGENAME}}]]
[[Category:Concept|{{PAGENAME}}]]
=Applies To=
This information applies to
* innovaphone Operator V9

The article's intent is to serve as the Operator 9 information center. The addressed audience is administrators, partners, resellers.

=Requirements=
*Windows 7, Windows Vista, Windows XP may work
*Windows Terminal Server
*1.5 GHz CPU (32-bit, or 64-bit), Dual-Core is recommended
*2 GB of RAM
*DirectX 9 capable graphics adapter

=More Information=
The innovaphone Operator 9 succeeds the innovaphone Operator 8.
*A busy lamp field(busy field, BLF) is the main addendum to the application.
**Condensed user information: Display Name, Number, PBX
**An entry's context menu allows to reveal detailed user informations for an entry
**Colored User status: available(registered & not engaged in a call), engaged in a call, not registered
**Symbolized presence status: presence activity, presence note(as tooltip)
**Display options for the BLF window
***within the main window
***within a separate window
***within a separate window on a 2nd monitor
**Two different entry layouts can be selected in three different sizes(small, medium, large)
**Freely placeable labels
<hr>
*Simplified usage
**Drag&Drop or keyboard-only usage possible
**main functionalities (accept call, initiate call) just with ENTER
**direct dialing without search / just use number
**Blind transfer eased - just use '+'
<hr>
*Search
**Full text search
***Fast, now the application default
***Targets large-scale installations
***Indexing: Long Name, Name, Number, Groups, PBX/Location
**Ldap search
***Support for Active Directory's attributes "department", "description"
***"department" offers button to search for alternative destinations within a department
**Pbx search
***"group" offers button to search for alternative destinations within a group
***Email integration, send notification on missed calls
**Individual PBX can be excluded/barred from the operator's search view
<hr>
*Call Switching
**Symbol indicating external calls
**Park+Wait functionality for blind-transferred calls towards busy internal destinations.
**Allows for operator procedure: ''The extension is busy. Do you want to wait?..''
**Blinking indicator for parked and muted calls
**Outgoing calls can be placed without paying attention to call diversions
**Call diversions can be manipulated from operator (if access right is granted)
**Call journal with simplified and detailed representation of any calls (successful, missed, etc)
<hr>
*Miscellaneous
**Alternative layout
**Nightswitch supported in GUI
**Secured access (HTTPS/TLS)
**Call context for currently active incoming call.

=Download=
* The software can be downloaded from the ''apps'' section: http://http://download.innovaphone.com/ice/9.00/#apps

=Application History=
The hotfix history can be found here [[Support:DVL-Roadmap_Operator_V9 | Support:DVL-Roadmap Operator V9]].

=Full Text Index=
One shortcoming of the predecessor application was the confinement to search for PBX users either ''by name'' or ''by long name'' only. The Operator 9 therefore offers the new search capability ''by full text index''.

The full text index was implemented application-local. That is, that index is not going to be maintained by the PBX, but by the Operator application itself in-RAM. Thus, making full text queries lightning fast.

The full text indexed is supposed to scale well within large installations. In contrast the busy lamp field is expected to be operable with up to ~300 pbx users.

Administrators must keep control of what is going to be fed into the index. This task must be accomplished by configuration of regular group memberships within a PBX. As a quick exemplary rule of thumb:
*Make the operator's PBX object an active member of a group e.g. "soap". Make all other user objects that shall be indexed (non-active) members of the same group "soap".

'''What is indexed?''' 
*Name
*Long Name
*Display Name
*Number
*Node number + number
*Groups
*PBX

=Busy-Field=

==Layout==
A screenshot featuring some numbered screen elements, explains the BLF's makeup.
[[Image:op9-bf-overview.jpg|center|thumb|200px|Overview, Operator 9]]
*1)BLF entry
*2)BLF label
*3)Thumb for menu panel
*4)Menu panel(slid out)
*5)Selector for BLF display as separate window or within main window
*6)Selector for the layout of BLF entries
*7)Erase button for selected BLF entries/labels
*8)Button to initially show the BLF
*9)Example of a BLF entry with a presence symbol

==Arranging Entries==

*Create a free line
**Select 2x entries
**Drag the selected entries onto some other entries
**All entries within the target line and all lines below are going to be moved downwards.
[[Image:op9-bf-edit-freeline.jpg|center|thumb|200px|Create a free line]]

*Adding a label
**Right-Click into a free location
**A context menu appears - select ''Add Label''
**A label is going to be placed.
**Left-Click into the label, in order to edit the label's text.
[[Image:Op9-bf-add-label.jpg|center|thumb|200px|Adding a label]]

*Changing the position of a single entry
**Left-Click the entry and keep the left mouse button pressed.
**Drag the entry into its new position.
**Drop the entry by releasing the mouse button.
In case of an entry already occupying the new position, the two entries are going to exchange their positions.
[[Image:op9-bf-xchng-entries.jpg|center|thumb|200px|Changing the position of a single entry]]

*Changing the position of multiple entries
**Left-Click into a free position and keep the left mouse button pressed.
**Open up a selection rectangle. Entries intersecting with the rectangle are going to be selected.
**Release the left mouse button.
**Left-Click onto one of the selected entries and keep the left mouse button pressed.
**Drag the entries into their new position.
**Drop the entries by releasing the mouse button.
In case of one or more entries already occupying the new position, the entire lines containing those entries and the lines below are going to be moved downwards.
[[Image:Op9-bf-xchng-bulk.jpg|center|thumb|200px|Changing the position of multiple entries]]

=Configuration=
This section hilights a few key concepts of the Operator configuration. A few prerequisites must be considered.
*The operator's phone must be configured, such that ''call waiting'' is enabled. This is important, because of situations whith more than one call being active at the phone. Some such scenarios may be obvious: operator user is engaged in a call while an internal caller is trying to directly call through to the operator's desk. Some such scenarios aren't obvious. For instance the operation to unpark a call may often coincide with a call just being signalled by a waiting queue towards the operator's phone.
*Within the PBX the value '''PBX/Configuration/Recall Timeout''' should be set to a value greater than 0 seconds. Otherwise the call list ''Transferred Calls'' will remain empty.
==General==
The application is going to establish at least two Soap sessions. One for the operator user's identity. And one for the query user's identity.

The first session is needed in order to receive call informations for the operator user's phone. This session will be established only at the PBX configured under '''IP Address'''.

The second session is needed to receive user informations for all PBX user objects that shall be full text indexed. It is also needed for all PBX user objects that shall appear within the busy field. The Operator is going to establish this session type at every known PBX.
*'''Query User''' As a rule of thumb
**Create a user object ''_TAPI_'' (or ''SOAP'') on all PBXs within the network of PBXs (if Slaves are replicated from a Master, just create this user at Master without assigning it to a PBX).
***The user ''_TAPI_'' must be an active member of a group ''tapi''(or ''soap'').
**All other users (also the ones at Slave PBXes) that shall be full text indexed must become a non-active member in the group ''tapi''.
**In case of slave scenarios, the slavePBX object at Master itself needs to be part of that group.

==WQ (Waiting Queue)==
A WQ teams-up with an operator's phone by a group membership.
*A waiting queue ''wq-reception'' may exist.
*The WQ is an active member of a group ''reception''.
*The operator user is a non-active member of the group ''reception''.

Calls for the WQ are from now on also signalled towards the operator.

<hr>
'''Nightswitch''' 
The nightswitch configuration is just a front-end for the PBX ''Boolean object''. Its actual purpose is to provide a means for a diversion. A diversion that leads callers into an out-of-business-hour announcement. Here is the idea behind:
*A waiting queue ''wq-reception'' may exist and is configured under '''WQ'''.
*Enter the number (55 in this example) towards the out-of-business-hour announcement under '''Diversion'''. It may be the number of a dedicated voicemail object.
*Configure the time definitions for the regular business hours.
**1st: Start 9:00, End 17:00, Mon-Fri
**2nd: Start 0:00, End 0:00, Sat-Sun
**As Mode select Automatic

'''Note''': The automatic mode may be overridden by selecting ''Manual On'' or ''Manual Off'' as mode. ''Manual On'' causes the CFU (see below) to become active immediately and permanently.

What happens behind the curtain is as follows:
*A new boolean object ''wq-reception-nightswitch'' will be created automatically by the Operator app'.
*The boolean object is configured with the time definitions from above.
*A CFU is configured at the WQ ''wq-reception''.
*The CFU will have the number 55 from above as destination.
*The CFU references the Boolean object ''wq-reception-nightswitch'' from above.

The mode selector for the boolean object will be available for the user. Watch out for the WQ calls list.

==Miscellaneous==
===Configuration of the Phone's Conference Facility (Recording-/Greeting Function)===
Every innovaphone telephone offers a tiny conference function. Besides its apparent use, the conference function may be utilized to realize audio recording.
The corresponding configuration page can be found within the phone's web UI under ''Configuration/RegistrationX/Recording''.

Within the context of the innovaphone Operator it may also be used to provide the means for a personal audio greeting. A greeting that is about to played right after an incoming call was connected. For each incoming call over the course of a working-day.

Both scenarios require a voicemail script.

'''Note:''' Only one of the two possibilities can be configured. Either the audio recording or the greeting function. The two cannot be used concurrently.

The following two sub-sections are going to explain the required configuration steps for both scenarios.

===Greeting Function===
A few assumptions are taken into consideration.
*The PBX box offers a CF-card that is up and running.
*A voicemail object is going to listen on number 77.

Deploy the following voicemail script (audio menu in english)
* download [[Media:Greeting.zip]]
* copy onto a CF-card underneath a directory ''greeting''

At the PBX create a new voicemail object
* Proceed to ''PBX/Objects/New Voicemail''
* Enter ''Long Name, Name, Number'' as eg.: ''vm-greet, vm-greet, 77''
* Enter the ''Script URL'' as http://127.0.0.1/drive/CF0/greeting/greet.xml

Configure the recording function at the operator user's telephone
* Proceed to ''Configuration/RegistrationX/Recording''
* Select ''manual'' as ''Mode''
* Enter ''77'' as ''Number''

Within the innovaphone Operator proceed to ''File/Configuration/Misc.''
*''Assignment of the Recording-function'': Choose ''Greeting''
*''Destination Number'': Enter the number (''77'' in this example) that was configured in the phone's web UI underneath ''Configuration/RegistrationX/Recording''.

The audio greeting will start automatically for incoming external calls. The decision which calls are treated as external calls is based on the configuration of ''File/Configuration/LDAP Location/External Line'' (Mostly ''0''). A button will be displayed on-top of the list of incoming calls, if an audio greeting is played. The button allows to stop the greeting.

The audio greeting won't be started for:
* a fallback call, i.e. a call that was blind-transferred, but never connected.
* a call that was unparked
* a call that was refetched from the list of blind-transferred calls
* internal calls

In order to record a new audio greeting
*Just dial the number of the voicemail object (''77'' in this example).
*The script will prompt for a key press on the telephone
*Record the new greeting and stop the recording with another key press on the telephone
*You will be prompted with the new greeting
*End the call (on-hook) - the new greeting will be active from now on.

===Recording Function===
This functionality is actually a reuse of a solution being available since firmware version 6. Please read through the following article:
*[[Howto:A Simple Recording Solution On-Top of The innovaphone Voicemail|A Simple Recording Solution On-Top of The innovaphone Voicemail]]

All that's needed to be configured within the innovaphone Operator can be found underneath ''File/Configuration/Misc.''.
*''Assignment of the Recording-function'': Choose ''Recording''
*''Destination Number'': Enter the number that was configured in the phone's web UI underneath ''Configuration/RegistrationX/Recording''.

A recording button will then be offered on-top of the list of incoming calls. The button allows to start/stop recording and serves as an indicator lamp.

== LDAP Profile: Estos MetaDirectory 3.5==

This article section will explain how to configure the MetaDirectory to enable full-text search by means of a single LDAP attribue.

In a standard configuration the search within the Operator application is performed according the edit field '''Configuration/LDAP/Name Attributes'''. The list of name attributes defaulted previously to '''company,sn,givenName''' and could be set by means of a profile button within the LDAP inline-help.

A second profile button '''Estos MetaDirectory 3.5''' was added into the inline-help. If that button was clicked, it sets the list of name attributes to a single attribute '''searchContact'''. The ''searchContact'' attribute is kind of a meta attribute, that doesn't physically exist within the LDAP database. It rather serves as a vehicle realizing a full-text query processing whereby multiple physical attributes will be considered by the MetaDirectory.

Which physical attributes are getting queried is subject of an administrative task. As the following screenshot illustrates, the MetaDirectoy's '''Search Assistant''' is the place where an administrator controls the behaviour of the full-text search triggered by the ''searchContact'' attribute. The search assistant allows to check multiple database fields within the column '''Contact search'''. All database fields enabled are going to be considered for the ''searchContact''-related full-text search.
[[Image:Howto fulltext search screen 01.png]]

As can be seen right next to the column ''Contact search'' resides the column '''Number search'''. The same principle applies. However, it is not targeting the attribute ''searchContact'', but the attribute '''searchNumber'''. This is why the edit field '''Configuration/LDAP/Number Attributes''' will be set to '''searchNumber''' when clicking the profile button mentioned above.

*Benefits
**Short and concise LDAP filters are sent towards the MetaDirectory
**Indexed search increases overall query performance

=Configuration, Specialties=
This section covers somewhat advanced configuration aspects.
==Suppress Call Display==
A privacy list may be administrated manually within the operator's configuration file. The purpose is to provide a means for privacy, such that call details won't be visible from within the application.
*Click on the button '''File/Configuration/Misc/AppData'''.
**A Windows Explorer is going to come up, showing the contents of ''C:\Users\<your user directory>\AppData\Roaming\innovaphone AG\innovaphone Operator\''.
*Terminate the operator.
*Open '''swconfig.xml''' witin a text editor
*Enter the list as in the following excerpt (''name=".."'' corresponds to the user's short name)
<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<privacy>
<hide name="mst"/>
</privacy>
...
</config>
</switchboard>
</code>

* It's also possible to add all objects to a privacy list by adapting the config part as below:

<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<privacy>
<hide hide-all="true"/>
</privacy>
...
</config>
</switchboard>
</code>

*Restart the app'.

==Unattended Installation==
The following command line for the MS Installer program msiexec<ref>Windows Installer, Command Line Options: http://msdn.microsoft.com/en-us/library/aa367988%28v=vs.85%29.aspx</ref> has been reported to be working with the ''All Users'' installation setting.
<code type="text">
msiexec /i innovaphone.operator.setup.msi /passive /l* "Logdatei.txt" INSTALLDIR="C:\Program Files\innovaphone AG\innovaphone® Operator\" ALLUSERS=1
</code>

==Start With A Disctinct UI Culture==
The system culture controls the UI culture. The Operator appears in english on an english OS.

To force a different culture
*'''Win Explorer''' Browse to ''C:\Program Files (x86)\innovaphone AG\innovaphone® Operator''
*Right-Click on innovaphone.operator
*A context menu opens. Select '''Send To Desktop As Shortcut'''.
*Locate the newly created shortcut/link on the desktop and click on '''Properties'''.
*Modify the target from
<code type="text">
"C:\Program Files (x86)\innovaphone AG\innovaphone® Operator\innovaphone.operator.exe"
</code>
Into
<code type="text">
"C:\Program Files (x86)\innovaphone AG\innovaphone® Operator\innovaphone.operator.exe" /culture de-DE
</code>

Possible cultures are
*'''english''' en-GB
*'''czech''' cs-CZ
*'''german''' de-DE
*'''italian''' it-IT
*'''dutch''' nl-NL
*'''french''' fr-FR
*'''norwegian''' nb-NO
*'''polish''' pl-PL

An alternative to the shortcut object vehicle is configuration file ''swconfig.xml''. The format is as follows
<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<culture>de-DE</culture>
...
</config>
</switchboard>
</code>

=Addressing Large Scale Installations=
One of the lengthy discussions throughout the product design phase concerned large installations. Say, installations with more than 300 pbx users, up to a few thousand of them.

To make a long story short - eventually it turned out the main gimmick, the new busy lamp field, wasn't suitable. With a BLF the need for a search function would have emerged which was deemed contradictory to the intended purpose of a BLF.

Hence, the existing PBX search function received a major overhaul by adding the new [[#Full_Text_Index | Full Text Index]]. The goal of the full text index was to provide a search function being perceived as fast and superior to the one of the predecessor application. The BLF was left as-is without an extra search capability.

Finally, a checklist aiding planning of large scale installations
*Make the operator an active member of a group e.g. "soap".
*Make all other pbx users, that shall be searchable non-active members of the same group "soap".
**Per PBX not more than 2000<ref>The PBX has a hard-coded limit of 2000 group members</ref><ref>If more than 2000 users are required, those must be distributed on multiple PBXs with 2000 "soap" members each</ref>
*Ensure the Operator 9's PBX search is configured for '''Full Text/Volltext'''
*On the PC running the Operator 9 watch out for resource consumption.
**A countermeasure against too much of memory consumption is to completely disable the BLF<ref>Calculate with 80KB per BLF entry</ref>. See the checkmark '''Configuration/Misc/BLF Deactivate'''.

=Troubleshooting=
==How to obtain logs with Operator Application==

When an error occurs the Operator Application will give an alert on status bar and we can click on "save trace" button to retrieve the log. However we can force the trace on Operator Application that will generate always the trace file.

To do so, we need to go File->Configuration then Misc-tab and enable "trace" option.

[[Image:Concept_Operator_Version_9_trace.png]]

=Known Issues=
==Application Won't Start On Windows XP==

'''Symptom''' 
The application doesn't start properly on Windows XP. An error text file is going to be generated comprising the following content:
<code text>
31.07.2009 16:40:46,innovaphone Operator,8.0.38.0

OS: Microsoft Windows NT 5.1.2600 Service Pack 2
CLR: 2.0.50727.1433

An internal error occurred

Alarms:
Exception, date=31.07.2009 16:40:45, info=unhandled exception
================================================================
'System.Windows.Controls.ToolTip' value cannot be assigned to property 'Value' of object 'System.Windows.Setter'.
'System.Windows.Controls.ToolTip' is not a valid value for 'Setter.Value';
values derived from Visual or ContentElement are not supported.
Error at object 'System.Windows.Controls.ToolTip' in markup file 'operator;component/activecallsincontrol.xaml'.
at System.Windows.Markup.XamlParseException.ThrowException(String message, Exception innerException, Int32 lineNumber, Int32 linePosition, Uri baseUri, XamlObjectIds currentXamlObjectIds, XamlObjectIds contextXamlObjectIds, Type objectType)
...
</code>

'''Solution''' 
Have a look into what Windows Update offers as optional components. If there's a cumulative update for .NET 2.0/3.0/3.5 you're asked to install said update (addendum: The update may also show up as ''.NET 3.5 SP1''<ref>.Net 3.5 SP1: http://www.microsoft.com/en-us/download/details.aspx?id=22</ref>). That update is going to upgrade the CLR onto the required version. Please note that Service Pack 3 is mandatory.

'''Remarks''' 
The original .Net Common Language Runtime (CLR) is not suitable and too old.

==Blind-Transferred Calls Don't Show Up in List of "Transferred Calls"==
'''Symptom''' 
Calls that were blind-transferred by the Operator application may probably not appear in the respective call list.

'''Solution''' 
*At the PBX browse to PBX/Config/General
*Enter something useful in seconds (30 or 60)
'''Remarks''' 
A blind-transferred call is going to fall-back after that amount of seconds if not accepted in-between.

==Blind-Transferred Calls Don't Fall Back==
'''Symptom''' 
Calls that were blind-transferred by the Operator application don't fall-back to the operator.

'''Solution''' 
*The cause and solution are the same as in [[#Blind-Transferred Calls Don't Show Up in List of "Transferred Calls"|Blind-Transferred Calls Don't Show Up in List of "Transferred Calls"]]

==Operator Freezes On Startup==
The operator application was reported to get stuck on startup. The user interface turned white and did not respond to any input.

'''Symptom''' 
The application window looks as follows [[Image:screenshot-oppi-freeze.jpg|center|thumb|200px|Operator freezes on startup]].

'''Solution''' 
This symptom can occur due to a corruption of the framework's font cache data file. Try the workaround:
*'''Start/Run''' of '''services.msc'''
*Stop the service ''Windows Presentation Foundation Font Cache 3.0.0.0''/''Windows Presentation Foundation-Schriftartcache 3.0.0.0''
*Now delete the system file ''FontCache3.0.0.0.dat''
<pre>
The file likely resides under Windows XP in
--
%systemdrive%\Documents and Settings\LocalService\Local Settings\Application Data

The file likely resides under Windows Vista/7 in
--
%windir%\ServiceProfiles\LocalService\AppData\Local</pre>
*Reboot the machine

==Operator Displays Corrupted Fonts==
After 2 years of service the operator application was reported to suddenly display corrupted fonts.

'''Symptom''' 
The application window looks as follows [[Image:Operator_font_corrupted.jpg|center|thumb|200px|Operator displays corrupted fonts]].

'''Solution''' 
This symptom occurred due to a corruption of the framework's font cache data file. Try the workaround:
*'''Start/Run''' of '''services.msc'''
*Stop the service ''Windows Presentation Foundation Font Cache 3.0.0.0''/''Windows Presentation Foundation-Schriftartcache 3.0.0.0''
*Now delete the system file ''FontCache3.0.0.0.dat''
<pre>
The file likely resides under Windows XP in
--
%systemdrive%\Documents and Settings\LocalService\Local Settings\Application Data

The file likely resides under Windows Vista/7 in
--
%windir%\ServiceProfiles\LocalService\AppData\Local</pre>
*Reboot the machine

'''Remarks''' 
It is the same root cause as above in [[#Operator_Freezes_On_Startup|Operator Freezes On Startup]].

==Pickup Of WQ Calls==
From on build 90112 the pickup of WQ calls is only possible for calls not in the CONNECT state.
*Activate the checkmark '''PBX/Objects/<WQ Object>/Queue/Operator connect for SOAP'''
**this setting guarantees that a WQ call is displayed as CONNECTed only in case of an operator actively talking to the caller party A.

==Not Working: ''Focus on incoming call''==
The configuration dialog offers an auto-focus checkmark '''File/Configuration/Misc/Focus on inc. call'''. Customers reported that the application manages getting into the foreground. However, without catching the keyboard focus. A final click into the application was necessary.

Instead, the application icon within the taskbar starts flashing, indicating that further user interaction is required.
The application window looks as follows
[[Image:Set-foreground-waiting.PNG|center|thumb|200px|Operator waiting for a click]].

This behaviour is by-design and cannot be circumvented in a common manner. An MS statement<ref>Set Foreground Window: http://msdn.microsoft.com/en-us/library/ms633539%28VS.85%29.aspx</ref> clarifies this OS-behaviour:
*''An application cannot force a window to the foreground while the user is working with another window. Instead, Windows flashes the taskbar button of the window to notify the user.''

The only reliable way to have the auto-focus feature working is by minimizing the application to the tray area. See the following menu button.
[[Image:Op-minimize-to-tray.png|center|thumb|200px|Button: Minimize to tray area]]
Auto-focusing from that window-state/application-state is supposed to be more reliable in getting the application into the foreground and assigning it the keyboard focus.

==Application Crash: Methode nicht gefunden/Method Not Found==

'''Symptom''' 
The application crashes - e.g. when searching - and prompts an exception labeled '''Methode nicht gefunden/Method Not Found'''.
<code text>
Exception, date=12.06.2013 16:35:52, info=unhandled exception
================================================================
Methode nicht gefunden: "System.Object[] innovaphone.idx.IFulltextIndex.Query(Char, System.String[])".
bei switchboard.Index.FtIndexQueryVlv(Char equalityTerminator, String[] terms, Int32 pageSize, VlvCursor& cursor)
bei switchboard.SearchPbxControl.PbxSearchFullTextExecute(String[] terms)
...
</code>

'''Solution''' 
De-install and afterwards re-install the application(The configuration won't be deleted, i.e. will remain.).

'''Remarks''' 
The root-cause is a DLL versioning problem. The problem may occur after an update-install took place. That is, where a newer Operator was installed over an older, existing installation.

==Inbound Calls Appear Doubled==
'''Symptom''' 
The upper-left list of calls titled ''Incoming calls for..'' displays a single call as two or even more calls.

'''Solution''' 
Configure a distinct '''Hardware ID''' of one of the operator's phones under '''File/Configuration/General/Hardware ID'''

'''Remarks''' 
The operator is likely to have multiple registrations active, originating from multiple endpoint devices. Only one of those devices shall be selected as the operator's active phone.

== Multiple Operator Instances and Nightswitch settings ==
'''Symptom''' 
Time settings will be empty or are not saved if more than one operator instance is used.

=Localization=
The article [[Howto:Assist_In_Localization_Of_Operator_Version_9|Howto:Assist In Localization Of Operator Version 9]] serves as a starting point, if you are interested in helping to localize the application.

=Notes=
<references/>

Reference:Configuration/BRI/Interop

2014-03-11T10:00:58Z

Tle:

Usually it should not be necessary to do any adjustments on this page. Nevertheless some ISDN implementation are not compatible to what we consider the standard.

{|
|valign=top nowrap=true|'''Automatic Keypad'''
|This options enables Automatic Keypad sending. This means that if the first dialed digit to be sent on this interface is either '*' or '#' the digits are not sent as called party number, but as Keypad information instead. This is used on some ISDN networks for non call related supplementary services (e.g. *21*No# to set call forwarding).
|-
|valign=top nowrap=true|'''Suppress Sending of HLC'''
| The HLC (Higher Layer Compatibility) information element is used to provide end to end information about the application (e.g. Telephony) of the call. Very rarely ISDN implementations do no support it and thus reject calls. With this checkmark the sending of the HLC can be suppressed.
|-
|valign=top nowrap=true|'''Suppress Sending of FTY'''
| The FTY (Facility) information element is used for supplementary services. This option supresses the sending of FTY to avoid problems with incompatibilities of the facilities. No Supplementary Services are possible in this case.
|-
|valign=top nowrap=true|'''Suppress Subaddress'''
| No subaddress information elements are transmitted.
|-
|valign=top nowrap=true|'''Suppress Connected Num.'''
| No connected number information elements are transmitted.
|-
|valign=top nowrap=true|'''No Restart'''
| The Restart procedure is used by the device after establishment of the link layer to make sure no call exists on any channel. This is useful because some PBXs do no clear all calls if the link layer is disconnected. With this option this restart procedure is disabled.
|-
|valign=top nowrap=true|'''Passive Layer2'''
| Normally the device tries to establish the link layer on point to point interfaces as soon as the physical layer is established. This behaviour is especially incompatible to some ISDN conformance test equipment even if it conforms to standard. This option turns this off.
|-
|valign=top nowrap=true|'''No Overlap Receive'''
| Normally, single digit dialing (overlapped sending) is not used to call terminals (that is, devices in TE mode) on point-to-multipoint connections. Under certain circumstances however, it is possible for gateways to be connected to a PABX system in precisely this mode and then also support incoming single digit dialing (overlapped receive). In this case, an incoming SETUP message is answered, as required in the standard, with a SETUP_ACK message. Some PABXs, however, do not expect this sort of message from terminal equipment and terminate the call at this point. In such a case, the No overlap receive setting prevents the gateway from answering the incoming SETUP message with a SETUP_ACK.
|-
|valign=top nowrap=true|'''No Disc'''
| No DISC message is transmitted. REL is transmitted instead.
|-
|valign=top nowrap=true|'''No Disc for Call Reject'''
| Call Rejection is done with REL message instead of DISC.
|-
|valign=top nowrap=true|'''Annex N'''
| Signals the sending of inband information during call establishment according to ETS 300 102-1 Annex n (only in TE mode).
|-
|valign=top nowrap=true|'''Automatic Progress'''
| Send a Progress message after any CallProceeding message to avoid short CallProceeding Timeout of 10s, which may be a problem with DECT handsets or if a CFNR to a public network is done.
|-
|valign=top nowrap=true|'''Volume'''
| Here, you can set a value in decibel (db) between -32db and +32db.
|-
|valign=top nowrap=true|'''CR Length'''
| Length of call reference value in bytes. Normally the length of the Call reference is defined by the standard. Especially in the QSIG environment deviations from the standard are found, so it can be adjusted manually.
|-
|valign=top nowrap=true|'''CHI Type'''
|Coding of the Channel Information Element is different for Basic Rate (BRI) and Primary rate (PRI) interfaces, but for QSIG the PRI coding is defined for BRI interfaces as well. Some QSIG implementation use BRI coding of the Channel Information Element on a BRI interface. With this option the coding can be adjusted manually.
|}

Reference8:Configuration/BRI/Interop

2014-03-11T10:00:36Z

Tle:

Usually it should not be necessary to do any adjustments on this page. Nevertheless some ISDN implementation are not compatible to what we consider the standard.

{|
|valign=top nowrap=true|'''Automatic Keypad'''
|This options enables Automatic Keypad sending. This means that if the first dialed digit to be sent on this interface is either '*' or '#' the digits are not sent as called party number, but as Keypad information instead. This is used on some ISDN networks for non call related supplementary services (e.g. *21*No# to set call forwarding).
|-
|valign=top nowrap=true|'''Suppress Sending of HLC'''
| The HLC (Higher Layer Compatibility) information element is used to provide end to end information about the application (e.g. Telephony) of the call. Very rarely ISDN implementations do no support it and thus reject calls. With this checkmark the sending of the HLC can be suppressed.
|-
|valign=top nowrap=true|'''Suppress Sending of FTY'''
| The FTY (Facility) information element is used for supplementary services. This option supresses the sending of FTY to avoid problems with incompatibilities of the facilities. No Supplementary Services are possible in this case.
|-
|valign=top nowrap=true|'''Suppress Subaddress'''
| No subaddress information elements are transmitted.
|-
|valign=top nowrap=true|'''Suppress Connected Num.'''
| No connected number information elements are transmitted.
|-
|valign=top nowrap=true|'''No Restart'''
| The Restart procedure is used by the device after establishment of the link layer to make sure no call exists on any channel. This is useful because some PBXs do no clear all calls if the link layer is disconnected. With this option this restart procedure is disabled.
|-
|valign=top nowrap=true|'''Passive Layer2'''
| Normally the device tries to establish the link layer on point to point interfaces as soon as the physical layer is established. This behaviour is especially incompatible to some ISDN conformance test equipment even if it conforms to standard. This option turns this off.
|-
|valign=top nowrap=true|'''No Overlap Receive'''
| Normally, single digit dialing (overlapped sending) is not used to call terminals (that is, devices in TE mode) on point-to-multipoint connections. Under certain circumstances however, it is possible for gateways to be connected to a PABX system in precisely this mode and then also support incoming single digit dialing (overlapped receive). In this case, an incoming SETUP message is answered, as required in the standard, with a SETUP_ACK message. Some PABXs, however, do not expect this sort of message from terminal equipment and terminate the call at this point. In such a case, the No overlap receive setting prevents the gateway from answering the incoming SETUP message with a SETUP_ACK.
|-
|valign=top nowrap=true|'''No Disc'''
| No DISC message is transmitted. REL is transmitted instead. If DISC is received a RELEASE response is sent right away.
|-
|valign=top nowrap=true|'''No Disc for Call Reject'''
| Call Rejection is done with REL message instead of DISC.
|-
|valign=top nowrap=true|'''Annex N'''
| Signals the sending of inband information during call establishment according to ETS 300 102-1 Annex n (only in TE mode).
|-
|valign=top nowrap=true|'''Automatic Progress'''
| Send a Progress message after any CallProceeding message to avoid short CallProceeding Timeout of 10s, which may be a problem with DECT handsets or if a CFNR to a public network is done.
|-
|valign=top nowrap=true|'''Volume'''
| Here, you can set a value in decibel (db) between -32db and +32db to define the output volume to the BRI interface.
|-
|valign=top nowrap=true|'''CR Length'''
| Length of call reference value in bytes. Normally the length of the Call reference is defined by the standard. Especially in the QSIG environment deviations from the standard are found, so it can be adjusted manually.
|-
|valign=top nowrap=true|'''CHI Type'''
|Coding of the Channel Information Element is different for Basic Rate (BRI) and Primary rate (PRI) interfaces, but for QSIG the PRI coding is defined for BRI interfaces as well. Some QSIG implementation use BRI coding of the Channel Information Element on a BRI interface. With this option the coding can be adjusted manually.
|}

Reference9:Interfaces/BRI/Interop

2014-03-11T10:00:14Z

Tle:

The '''Interop''' submenu normally does not have to be adjusted. This is only necessary if, for example, malfunctions occur when transmitting H.323 calls.

Not all ISDN implementations are prepared to receive certain standard-compliant '''information elements''' (referred to as IEs). Such IEs can be created, for example, when linking up different PABXs or transmitting H.323 calls to an ISDN interface and vice-versa.

If malfunctions are caused by the transmission of certain IEs, the gateways can be made to remove such IEs from the transmitted messages.

;Automatic Keypad: This options enables Automatic Keypad sending. This means that if the first dialed digit to be sent on this interface is either '*' or '#' the digits are not sent as called party number, but as Keypad information instead. This is used on some ISDN networks for non call related supplementary services (e.g. *21*No# to set call forwarding).

;Suppress HLC: The HLC (Higher Layer Compatibility) information element is used to provide end to end information about the application (e.g. Telephony) of the call. Very rarely ISDN implementations do no support it and thus reject calls. With this checkmark the sending of the HLC can be suppressed.

;Suppress FTY: The FTY (Facility) information element is used for supplementary services. This option supresses the sending of FTY to avoid problems with incompatibilities of the facilities. No Supplementary Services are possible in this case.

;Suppress Subaddress: No subaddress information elements are transmitted.

;Suppress Connected Num.: No connected number information elements are transmitted.

;No Restart: The Restart procedure is used by the device after establishment of the link layer to make sure no call exists on any channel. This is useful because some PBXs do no clear all calls if the link layer is disconnected. With this option this restart procedure is disabled.

;Passive Layer2: Normally the device tries to establish the link layer on point to point interfaces as soon as the physical layer is established. This behaviour is especially incompatible to some ISDN conformance test equipment even if it conforms to standard. This option turns this off.

;No Overlap Receive: Normally, single digit dialing (overlapped sending) is not used to call terminals (that is, devices in TE mode) on point-to-multipoint connections. Under certain circumstances however, it is possible for gateways to be connected to a PABX system in precisely this mode and then also support incoming single digit dialing (overlapped receive). In this case, an incoming SETUP message is answered, as required in the standard, with a SETUP_ACK message. Some PABXs, however, do not expect this sort of message from terminal equipment and terminate the call at this point. In such a case, the No overlap receive setting prevents the gateway from answering the incoming SETUP message with a SETUP_ACK.

;No Disc: No DISC message is transmitted. REL is transmitted instead. If DISC is received a RELEASE response is sent right away.

;No Disc for Call Reject: Call Rejection is done with REL message instead of DISC.

;Annex N: Signals the sending of inband information during call establishment according to ETS 300 102-1 Annex n (only in TE mode).

;Automatic Progress: Send PROGRESS message automatically after a CALL_PROC message. Some networks have short timeouts (4-6s) for incoming calls after a CALL_PROC (which indicates that the called number exists and is complete) is sent. This can create problems if the incoming call is forwarded to a mobile number or any other destination which takes some time to respond. The PROGRESS message stops this timer.

;Network CLI only: Any CLI received on incoming calls, which is not marked as 'Network provided' or 'User provided and screened' is igored. This may be needed for applications which do not want to trust a CLI provided by the CLIP no screening feature.

;Volume: Here, you can set a value in decibel (dB) between -32dB and +32dB to define the output volume to the BRI interface.

;CR Length: Length of call reference value in bytes. Normally the length of the Call reference is defined by the standard. Especially in the QSIG environment deviations from the standard are found, so it can be adjusted manually.

;CHI Type: Coding of the Channel Information Element is different for Basic Rate (BRI) and Primary rate (PRI) interfaces, but for QSIG the PRI coding is defined for BRI interfaces as well. Some QSIG implementation use BRI coding of the Channel Information Element on a BRI interface. With this option the coding can be adjusted manually.