innovaphone wiki - User contributions [en]

Reference10:Concept Linux Application Platform

2017-03-24T09:25:29Z

Muelbuesch: /* Requirements */

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

=====saveinnovaphone-applicationnamelogs=====

Saves log files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportinglogs'''

=====saveinnovaphone-applicationnamecfgs=====

Saves all neccessary configuration files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingcfgs'''

=====saveinnovaphone-applicationnamedb=====

Saves ddbb if existing as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingdb'''

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

====WinSCP====

[https://winscp.net WinSCP] 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:PBX/Objects/Waiting Queue

2015-02-26T10:56:49Z

Muelbuesch: corrected typo

The Waiting Queue PBX object is used to put calls sent to this object into a queue. While the call is in the queue, it may either remain in alerting state or it be connected with an announcement played. Two announcements can be configured played one after the other, the second is repeated. Calls which are in the queue can be sent to groups of operators configured for the queue. Calls are strictly sent in a first in first out manner to operators. The next call is sent only after the previous call is connected. Destinations can be configured, which can be dialed using DTMF while a call is in the queue and connected.

'''The Waiting Queue PBX object does not support DTMF tone detection. Only 'telephone-event' (RFC-2833) or DTMF signalling (H.245 User Input Indication / SIP INFO(dtmf-relay)) are supported.'''

== Configuration ==

=== Addressing ===

The Long Name, Name Number and Node configuration parameters have the same meaning as for any other object.

=== Registration ===

Hardware ID, PBX, Send Number, Password, Filter, Diversion Filter and Group Indications are used only for endpoints registered directly to the Waiting Queue object. This maybe useful to set diversions for the Waiting Queue object and such endpoints can be used to make calls and are treated as operators of the Waiting Queue.

=== CFNR Timeout ===

The timeout used for call forward no response. See Diversions.

=== Max Calls ===

This configuration parameter can be used to limit the calls in the queue. Calls connceted to a operator do not count in this respect anymore.

=== Announcements ===

For announcements the URL and/or Extern Name/no have to be configured. If no Extern Name/no is configured the local HTTP interface is used to retrieve the announcements. The URL has the following format:

<nowiki>http://<addr>/<filename.$coder>?coder=<coder-list>[&repeat=true|repeat=n|disc=true|random=true|record=true]</nowiki>

{|
|valign=top nowrap=true|'''addr'''
|The IP address of the web server. A DNS name cannot be used here.
|-
|valign=top nowrap=true|'''filename.$coder'''
|The filename of the announcement files including any path. $coder will be replaced by the actual coder used.
|-
|valign=top nowrap=true|'''coder-list'''
|A comma seperated list of all available coder. For each coder in the list the respective announcement file must be available on the server. The available coders are g729,g711a,g711u,g723.
|-
|valign=top nowrap=true|'''repeat=true'''
|If this is present the announcement will be repeated. If this is used for the 1st Announcement the 2nd Announcement will never be played.
|-
|valign=top nowrap=true|'''repeat=<n>'''
|If this is present the announcement will be repeated another n times.

|-
|valign=top nowrap=true|'''fallback=true'''
|If this is present and the specified announcement file is not available, the built-in MOH pattern will be played.
|-
|valign=top nowrap=true|'''random=true'''
|If this is present, the announcement will be started at a random offset, so each caller will hear it from a different point in time. This works with non-local URLs only though.
|}

Example

<nowiki>http://145.253.157.2/announce/welcome.$coder?coder=g711a,g711u,g729</nowiki>

If no URL is configured the local HTTP interface plays the built-in music on hold by default.

If an Extern Name/No is configured then no local HTTP interface is used, but a call is sent to the configured Name/No. The URL is sent with this call as user-user-info, so that a remote HTTP interface can use it the same way as the local HTTP interface. As destination of the call any voip endpoint can be used.

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

There are 2 pseudo URLs available, TONE and MOH. Such URLs will be interpreted locally and connect to the systems tone and music-on-hold interface, respectively.

{|
|valign=top nowrap=true|'''TONE'''
|as URL will produce a constant tone (often recogonized as a dial-tone). You can add a '''?tone=ringback''' which will give you a tone sequence with 1 second tone and 4 seconds silence (this is often recognized as a ring-back tone).

You can also add a '''?tone=busy''' which will give you a busy tone sequence. Notice that the queue is only playing the busy tone, it will not disconnect the call. (To disconnect the call after a while, use the CFNR to a not existing user or to a Disconnect user object, routed to the DISC interface.)
|-
|valign=top nowrap=true|'''MOH'''
|will produce the built-in music-on-hold. Please note that both TONE and MOH never end, so '''repeat=true''' is not required and '''disc=true''' will have no effect.
|}

'''V7 hotifx9''': At any location inside the URL placeholders can be used, which are replaced by a string defined for the placeholder. The following placeholders are available:
{|
|valign=top nowrap=true|'''#p'''
|Position of this call within the queue. '''0''' means the next available operator will answer this call.
|-
|valign=top nowrap=true|'''##'''
|Is replaced by '''#'''
|}

Example

<nowiki>http://145.253.157.2/announce/queue_place#p.$coder?coder=g711a,g711u,g729</nowiki>

will be resolved to the files ''queue_place1.g711a'',''queue_place2.g711a'', ''queue_place3.g711a''...., depended on place in queue. So you have to create one set of prompt files for each queue place.

'''Recomended solution:''' Create a ''welcome'' prompt in 1st Announcement and a ''queue_place'' prompt (witch will be repeated) in 2nd Announcement. This way the every time the 2nd Announcement it's repeated it will provide the queue position to the caller.

=== Max Call/Operator(%) ===

This configuration parameter allows to limit the number of current calls depending on the number of operator registrations in the primary group. Only the configured percentage of operator registrations are accepted as calls. Calls currently connected to operators do count in this context. For example if 2 operators are registered and the value is set to 150%, the 4th call received will get a busy. Note that only operators in the primary group count for this, this means if there is no primary group configured all calls are rejected with busy if any value is entered here.

=== Alert Timeout ===

The timeout (in seconds) after which the Waiting Queue connects incoming calls. If no timeout is configured the Waiting Queue will never connect. If a timeout of 0 is configured the Waiting Queue connects right away.

=== Round Robin Timeout ===

If a round robin timeout is configured the call is not sent to all members of the primary group at the same time, but it starts with one only. After the round robin timeout has expired, the call is sent to all members of the primary group. The operator used for the first call changes in a round robin manner. If the checkmark '''Speedup if more calls waiting''' is set, the round robin timeout will be reduced as soon as a second call arrives.

=== Primary Group/Timeout ===

The call is sent to this group first, either to all members at the same time, or in a round robin manner. After the configured Primary Group Timeout expires the call is sent to all operators. If Primary group operators are busy the call is immediately sent to Secondary Groups members. Operators are all members of groups in which the Waiting Queue object itself is active member. The operators do not need to be active members of these groups. If Primary Group Timout is empty, the call is sent to primary and secondary group immediately.

=== Support for RTP-DTMF ===

If the announcement interface for a Waiting queue is not the PBX internal one and the calling endpoint can only do RTP-DTMF, the announcement interface receives the RTP-DTMF and not the waiting queue. When this checkmark is set, the '''uui-dtmf=on''' argument to the URL is added, which tells the announcement interface to send back the received DTMF as USER-INFO.

This feature is needed for a Hosting Scenario where the PBX is located in a private network and the Media interface on a different system in the public network.

=== Operator connect for SOAP ===

On the SOAP/TAPI interface a call to a waiting queue is normally indicated as connected as soon it is connected signalingwise, this means it is indicated as connected if an announcement is played. This behaviour can be changed so that it is indicated connected only after an operator has accepted the call by setting this checkmark. This also will affect the PBX CDRs state accordingly.

=== Call busy Operators ===

Normally an operator who is already engaged in a Waiting Object call is not called again. If this checkmark is set, calls are delivered to these (busy) operators as well.

=== CFU disables Operator ===

If this checkmark is set a operator which has a CFU set is not called.

=== No Mobility for Operators ===

If this checkmark is set, mobility for operators is not executed.

=== Announcement w/o Connect ===

If this checkmark is set, no connect is sent on incoming calls to play the announcements. This feature allows to provide free-of-charge waiting queues. For this to work, the carrier has to support early media (and not all do, for example German Telekom is known to not support this feature as of December 2012 on ISDN lines). On TE ISDN interfaces the Annex-N option has to be enabled for this.

=== Presence Disables Operator ===

If this checkmark is set, no calls are sent to an operator with presence information set.

=== Set Operator Presence ===

If this checkmark is set the presence of an operator is set to busy whenever the operator accepts a call. A timeout can be set after which this presence information is cleared again after the call release.

=== DTMF destinations ===

A list of DTMF destinations can be configured. Any DTMF digits dialed after the call is connected to an announcement is matched to this list. If a match is found the call is sent to Dest. No/Dest. Name. If no Dest. No/Dest. Name is configured more DTMF digits may be dialed for the final destination. If the destination of the call is not an endpoint, but a gateway (Trunk object, Gateway object), the call is sent only after a timeout of 4s after the last digit is dialed.

A '.' entered as DTMF map will catch all DTMF digits dialled after this map and append them at the end of ''Dest. No''.

Example
DTMF Dest. No Description
55. 11 if the DTMF sequence "55222" is dialled, the destination number is "11222"
. <empty> the dialled DTMF sequence is passed completely to the destination

A '~' character before the DTMF destination indicates that no ct_complete shall be generated. This means the dialed DTMF destination does not show up in the redial list of the phone.

== Call Forwarding ==

Call Forwarding can be used with the Waiting Queue object and can be set/reset by endpoints registered to the Waiting Queue object itself.

{|
|valign=top nowrap=true|'''CFU'''
|Executed as usual
|-
|valign=top nowrap=true|'''CFB'''
|Executed if the Busy on ... calls condition or the Max Call/Operator(%) condition applies.
|-
|valign=top nowrap=true|'''CFNR'''
|Executed if the CFNR timeout expires and no operator has accepted the call, even if the call is connected to an announcement or if the first announcement ends and no second announcement is configured.
|}

Reference9:PBX/Objects/Edit Rights

2014-05-14T13:53:00Z

Muelbuesch: /* Viewing only */

With this page PBX administration rights can be configured for a user. The user may login to the system using the 'Name' and the 'Password' configured in the User object as authentication.

== Levels ==

See note on [[Reference9:Services/HTTP/Server | ''Password protect all HTTP pages'' ]] for limitations when this flag is used.

=== Full PBX Administration ===

All settings of the PBX and PBX objects may be changed the same way as a system administrator can do. Including the rights for users.

=== Administration of all Objects ===

All settings of all PBX objects may be changed. The 'General', 'Password' and 'Filter' settings may not be changed.

=== Administration of non critical Objects ===

Objects which are marked as 'critical' and the 'critical' flag itself may not be changed.

=== Groups/Call Forwards only ===

Only group memberships and call forward settings of non-critical objects may be changed.

=== Viewing only ===
You can only view the objects, it's not allowed to configure or change any settings.

== Limit to Node ==

Except for the 'Full PBX Administration' right the rights to change any objects can also be limited to a single node.

Reference9:PBX/Objects/Edit Rights

2014-05-14T13:52:46Z

Muelbuesch: /* Viewing only */

With this page PBX administration rights can be configured for a user. The user may login to the system using the 'Name' and the 'Password' configured in the User object as authentication.

== Levels ==

See note on [[Reference9:Services/HTTP/Server | ''Password protect all HTTP pages'' ]] for limitations when this flag is used.

=== Full PBX Administration ===

All settings of the PBX and PBX objects may be changed the same way as a system administrator can do. Including the rights for users.

=== Administration of all Objects ===

All settings of all PBX objects may be changed. The 'General', 'Password' and 'Filter' settings may not be changed.

=== Administration of non critical Objects ===

Objects which are marked as 'critical' and the 'critical' flag itself may not be changed.

=== Groups/Call Forwards only ===

Only group memberships and call forward settings of non-critical objects may be changed.

=== Viewing only ===
you can only view the objects, it's not allowed to configure or change any settings.

== Limit to Node ==

Except for the 'Full PBX Administration' right the rights to change any objects can also be limited to a single node.

Reference:Configuration/ETH/DHCP-Server

2014-05-12T09:40:25Z

Muelbuesch: Typo!

If the DHCP server was enabled (see chapter entitled "[[Reference:Configuration/ETH/DHCP|Configuration/ETH0-1/DHCP]]"), it can be configured here.

All settings marked with a "'''*'''" are innovaphone-specific settings that may only be found with innovaphone devices.

{|
|valign=top nowrap=true|'''Lease Time [min]:'''
| The validity period of the DHCP lease in minutes.
|-
|valign=top nowrap=true|'''Check Interval [min]:'''
| The interval (in minutes), at which a check is made whether the DHCP lease is still valid.
|}

== Address Ranges: ==
{|
|valign=top nowrap=true|'''First Address:'''
| The IP-Adresse that represents the start of the address range (for example, 192.168.1.100).
|-
|valign=top nowrap=true|'''Last Address:'''
| The IP-Adresse that represents the end of the address range (for example, 192.168.1.110).
|}

== Offer Parameters: ==
{|
|valign=top nowrap=true|'''Network Mask:'''
| The network mask in respect of the IP-Adress (for example, 192.168.1.100 corresponds to the network mask 255.255.255.0).
|-
|valign=top nowrap=true|'''Default Gateway:'''
| Standard router address (for example, 192.168.1.1).
|-
|valign=top nowrap=true|'''TOS Priority:'''
| ToS (Type of Service) value for voice packets (0x10).
|-
|valign=top nowrap=true|'''IP Routing:'''
| List of static IP-Routes in form of comma separated ''Address:Mask:Gateway'' triples (for example, 192.168.20.0:255.255.255.0:192.168.1.2,192.168.30.0:255.255.255.0:192.168.1.3).
|-
|valign=top nowrap=true|'''DNS Server 1:'''
| Primary DNS server address.
|-
|valign=top nowrap=true|'''DNS Server 2:'''
| Secondary DNS server address.
|-
|valign=top nowrap=true|'''Domain Name:'''
| Domain name that client should use when resolving hostnames via DNS (aka primary DNS prefix).
|-
|valign=top nowrap=true|'''Syslog Server:'''
| Syslog server address.
|-
|valign=top nowrap=true|'''Time Server:'''
| Time server address.
|-
|valign=top nowrap=true|'''Timezone String *:'''
| Time zone setting according to the IEEE POSIX standard (for example, CET-1CEST-2,M3.5.0/2,M10.5.0/3).
|-
|valign=top nowrap=true|'''TFTP Server:'''
| The TFTP server address.
|-
|valign=top nowrap=true|'''WINS Server:'''
| The WINS server address.
|-
|valign=top nowrap=true|'''Primary Gatekeeper *:'''
| The primary gatekeeper IP address.
|-
|valign=top nowrap=true|'''Secondary Gatekeeper *:'''
| The alternative Gatekeeper IP address.
|-
|valign=top nowrap=true|'''Coder *:'''
| Coder preference for VoIP telephones. In addition to the preference for the general coder, the preference for the local network coder can be specified here (since V6.00 SR1-hotfix3). G729A,60/G711A,30 for example defines G729A as the general coder and G711A as the local network coder.
You can enable SRTP on all phones by adding an "x" here like: G729A,60,x
|-
|valign=top nowrap=true|'''Gatekeeper Identifier *:'''
| The VoIP gatekeeper or the gatekeeper ID for VoIP telephones.
|-
|valign=top nowrap=true|'''Dial Tones *:'''
| The dial tone that is transmitted as the standard dial tone to the VoIP telephones (for example, German PBX = as German PBX, US = US dial tone, UK = British dial tone).
|-
|valign=top nowrap=true|'''Enblock Dialling Timeout [s] *:'''
| Switches on enbloc dialling for VoIP telephones.
|-
|valign=top nowrap=true|'''Faststart [0|1] *:'''
| Faststart 0/1 turns off/on the H.323 Faststart procedure. If this option is not defined the default (on) applies.
|-
|valign=top nowrap=true|'''Tunneling [0|1] *:'''
| Tunneling 0/1 turns off/on the H.245 Tunneling procedure. If this option is not defined the default (on) applies.
|-
|valign=top nowrap=true|'''Local Networks *:'''
| List of local networks in form of comma separated ''Address:Mask'' pairs (for example, 192.168.1.0:255.255.255.0,192.168.2.0:255.255.255.0). For VoIP Calls that end up in a local network the device will try to use the coder preferred for the local network (as provided in the Coder option or defined locally).
|-
|valign=top nowrap=true|'''Language *:'''
| All VoIP telephones that receive their IP-Adresse via DHCP have the language defined here set up as the standard language.
|-
|valign=top nowrap=true|'''Dialing Location *:'''
| Defines the various PBX access numbers on VoIP telephones for directory access. This character string has to contain the following options:
* cc = country code
* ac = area code
* ntp = national trunk prefix (carrier specific)
* itp = international trunk prefix (carrier specific)
* col = external line prefix (PBX specific)
* pbx = subscriber number (used to map incoming called party numbers to internal extensions, PBX specific)
A correct string may look like this: "cc 49 ac 7031 ntp 0 itp 00 col 0 pbx 73009".
|-
|valign=top nowrap=true|'''AM/PM Clock [0|1]:'''
| Enables/disables the English time format for VoIP telephones. The German time format is displayed as standard: "dd.mm.yy hh:mm, 24-hour clock." If a 1 is entered in this field, the English time format "mm/dd hh:mm xm, 12-hour am/pm clock" is displayed.
|-
|valign=top nowrap=true|'''LDAP Directory:'''
| To allocate a functioning LDAP configuration to all VoIP devices integrated via DHCP, a configuration character string can be entered in the LDAP Directory field. You obtain this configuration character string by executing the following command in the browser of a configured device: "<IP-Adresse of the VoIP device>/!mod cmd PHONE DIR ldap-config". When this command has been executed, a configuration character string is output in the browser, which you copy and paste into the LDAP Directory field of the DHCP server. In this way, all further devices are given a correct LDAP configuration.
|-
|valign=top nowrap=true|'''Update Interval [min]:'''
| All devices integrated via DHCP are assigned the interval specified here in the Interval [min] field of the update server (see chapter entitled "[[Reference:Configuration/General/Update|Configuration/General/Update]]").
|-
|valign=top nowrap=true|'''Update Server URL:'''
| All devices integrated via DHCP are assigned the URL specified here (for example, <nowiki>http://192.168.1.2/update/script.htm</nowiki>) in the Command File URL field of the update server (see chapter entitled "[[Reference:Configuration/General/Update|Configuration/General/Update]]"). An automated update of the devices is thereby ensured.
|-
|valign=top nowrap=true|'''802.1q VLAN ID:'''
| The configuration at the switch must be observed for setting the VLAN ID. An empty 802.1q VLAN ID field (16 bit) assumes the value 0. The VLAN ID with the value 0 switches QoS (Quality of Service) off according to 802.1q ab. If the switch at the port to the innovaphone device happens to be configured to a different VLAN ID, the same value must be specified here to allow a prioritisation from the Ethernet. To be able to distinguish between the VLANs, the Ethernet packet is extended by 4 bytes, of which 12 bits are intended for the inclusion of the VLAN ID, making 4094 VLANs possible (VLAN ID 0 and 4095 are reserved or invalid).
|-
|valign=top nowrap=true|'''802.1p VLAN Priority'''
| In the 802.1p VLAN Priority field (3 bit), the associated VLAN priority level (a value between 0 and 7) can be specified, in order that voice data is given priority forwarding, for example.
|}

==DHCP Vendor-Optioncodes==

For a description howto implement the Innovaphone DHCP-Options in Microsoft or Linux DHCP Server Software refer to
[[Howto:DHCP client]]

Howto:Pcap

2014-05-08T09:19:11Z

Muelbuesch: /* log2pcap */

With remote PCAP, network traffic can be captured directly from another network device, instead of capturing the network traffic from the own device.

==Remote PCAP==
===Requirements===

* You should have installed the latest wireshark release 1.10.6 with the latest innovaphone dll [http://www.wireshark.org/download.html Wireshark Download]
* Required and optional tools (innovaphone_winXX.dll and log2pcap.exe): open the [http://download.innovaphone.com/ice/download/p/6.00/apps/ V6 application page], select the latest 60000xxx folder and download the '''tools.zip'''. You will just need the innovaphone_win32.dll or innovaphone_win64.dll, depending on your installed wireshark version, 32 bit or 64 bit. Older wireshark versions won't work with the latest innovaphone_winXX.dll!
* To view the standard debug output, you have to install the innovaphone_winXX.dll, which you'll find in the tools package. Just copy the dll to your wireshark plugin directory and pay attention on your currently used version (e.g.: c:\programme\wireshark\plugins\1.6.0\).
* To view ISDN LAPD/Q.931 packets, you also have to install the innovaphone.dll.
* Open the [http://wiki.innovaphone.com/index.php?title=Image:Pcap_example_isdn.zip example pcap file with lapd and q.931 packets] to check your current installation. It should look like this, if you have the innovaphone_winXX.dll correctly installed:

[[Image:Pcap_sample_isdn.jpg|center|thumb|200px|PCAP ISDN example]]

===Setting up the rpcap server===

* The rpcap server can be any innovaphone device.
* The remote pcap server is disabled per default. To enable it, just go to Diagnostics->Tracing and check the "Enable" flag in the "Remote PCAP" group. If you are experiencing problems, also enable the trace flag with "config add PCAP /trace".
* To capture all ip traffic (udp and tcp), enable the "IP (all tcp/udp traffic)" flag in the group "IP". Otherwise just enable all the trace flags on the modules you want to capture.

===Capturing with wireshark===

===1.x.x - 1.7.x===
Open your wireshark and the capture options dialogue. Choose "remote" from the dropdown list and
Type "<IP-ADDRESS>/TRACE" into the host field.

It should look like this: (Screenshot from older Wireshark, v.1.2.2)
[[Image:Wireshark_1.2.2_trace_settings.PNG|center|thumb|200px|Wireshark capture options]]

Then just click on "Start" to start capturing.
 

=== >= 1.8.x ===

Open your wireshark and „Capture Options“->“Manage Interfaces“->“Remote Interfaces“. Add the IP address of your device. 
The remote interface will be listed in your interface now and you can select it for capturing data.

[[Image:Wireshark_1.8.6_settings.png|center|thumb|200px|Wireshark capture options]]
 

===Supported protocols===

* ISDN: LAPD L2/L3 with dissector innovaphone.dll (enable Diagnostics->Tracing TELX/PRIX/PPP)
* AC DSP: dsp with dissector Ac49xPacketRecording.dll (enable Diagnostics->Tracing->VOIP DSP)
* PPPoE: flag "/pcap" on module(s) PPPOE0/PPPOE1 enables pcap tracing

* All TCP/UDP protocols which are supported by native wireshark dissectors or other dissectors which can be found searching the internet.
e.g.:
SIP
H.323
H.245

Enable the corresponding flags under Diagnostics->Tracing, if you only want to see specific UDP/TCP protocols. To see all, enable the "All TCP/UDP Traffic" flag under Diagnostics->Tracing.

==PCAP Log==

Another possibility to get a pcap log file is to open http://IP/log.pcap
This file has a limited size just as the normal log file.

==log2pcap==

You need the tool log2pcap from the tools package, if you have a log.txt file, which contains pcap packets and you want to view them in wireshark. You can find the tool in the apps tool package (see above).

Usage:
# log2pcap.exe input1 input2 ... inputX
# drag&drop one or more files on the log2pcap.exe
# use an asterisk like "log2pcap c:\*.txt" to convert all txt files into pcap files. Things like c:\test*.txt are not supported.

* The resulting file name is always inputx.pcap (e.g. log.txt is converted into log.txt.pcap).

Note: if you have a trace of a little endian box (e.g. IP3000, IP21) with V6 SR1 or SR2, you have to use the "-srlefix" switch (available since 08-1007):

log2pcap.exe input1 -srlefix

==General Informations==

===Reading PCAP Traces===

Non-IP Pcap packets will nevertheless show source and destination IP addresses. 127.0.0.1 stand in for the traced device. So if for example a Q.931 SETUP messages is sent from 127.0.0.0 to 127.0.0.1, then it is an incoming setup.

===Disabling PCAP traces===

You can disable the whole pcap tracing. Just configure a /disable-pcap to the CMD0 module. This can be useful if you do not want to see pcap traces in your log file.

===Used ports===

* The debug traces are encapsulated in UDP packets with port 4.
* The isdn traces are encapsulated in UDP packets with port 4.
* The ac dsp traces are encapsulated in UDP packets with port 50001.
* Wireshark uses port 2002 to connect to the running rpcap-server
* rpcap packets are transfered over a dynamically assigned port between server and client

===Additional Remote PCAP trace===

You can trace the remote pcap protocol with adding the trace flag by "config add PCAP /trace" if you are experiencing connection issues.

===Timestamps===

Since V7 Hotfix 26 and V8 Hotfix 13, the ntp timestamp is used instead of the uptime in rpcap packages. In converted log files with log2pcap, uptime is still used.

==Known Problems==

* Converting a log from a little endian box (like IP3000 and IP21) with firmware V6 SR1 or SR2 with the tool log2pcap will only work with log2pcap 08-1007 or higher and the switch "-srlefix", see [[:#log2pcap|log2pcap]].
* Ac49xPacketRecording.dll works only with 0.99.7. Higher versions of wireshark won't start, if this dll was copied to the dll folder!
* Also some other dlls, contained in the tools package, won't work with each wireshark version. Just innovaphone.dll is always working.
* Even though ''All TCP/UDP Traffic'' is turned on, packets sent to the box acting as rpcap provider to a port that is not handled by the box (that is, where no listening socket is active) will currently not be shown
* If you use a 64-bit Windows Pc then you will need another innovaphone.dll, which is also contained in the latest tool package.
* The custom IP header from captured innovaphone packets contains dummy values for TOS (0), id (0), fragment offset (0) and TTL (128)
* After version 1.8.6 of wireshark the h225 packets are listed as malformed. So higher versions of wireshark could give troubles debugging the h.323 calls.
* '''Couldn't set the capture buffer size!''': if you're experiencing this error message, please start wireshark with the option "-B 1" to set the buffer size to 1 MB

==Related Articles==

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

Reference9:Gateway/CGPN-Maps

2014-05-07T14:27:02Z

Muelbuesch: /* Presentation */

The CGPN (Calling Party Number) can be changed with mappings entered here for a call sent thru the respective route. A headmatch of the received number is performed and the matching digits are replaced by the out digits. '?' can be used to match any digit.

If the call is received from an interface configured as Gatekeeper/Registrar, the mapping can be restricted to a certain registration.

On presentation restricted numbers can be matched and the presentation restricted property of a calling party number can be set or cleared.

The DGPN (Diverting Party Number) is also changed according to the configured CGPN mapping.

If there are multipe CGPN-Maps, only the first one matching is used.

== Configuration ==

=== GK Reg. Name ===

If configured, the mapping is applied only if the call is received from a Gatekeeper/Registrar interface and the name configured for the registration matches this name.

=== Number In ===

Digits used for the headmatch on the received number. In addition to the normal dialing digits (0..9,*,#) the following characters have special meaning:

;R: If 'R' is used as first digit of the number only numbers with 'presentation restricted' match. In this case the 'presentation restricted' property is cleared if 'R' is not used on 'Number Out'.

;?: Can be used at any place inside the number and means that any received digit matches.

;.: Can be used at any place inside the number and means that any received digit matches. All input digits starting with the first digit matching to '.' are copied to the output number.

;!: Can be used at the end of the number. It indicates that all digits received behind the matching digits shall be discarded.

=== Number Out ===

The matching digits are replaced by this number. A'? is used as placeholder to be replaced by digits matched to '?' in number in. A 'R' as first character means that the 'presentation restricted' property will be set for the calling party number.

=== Presentation ===

By using 'Set Presentation Restricted', CLIR (Calling Line Identification Restricted) can be activated. With 'Clear Presentation Restricted' CLIR is deactivated. This is a more convenient way to configure CLIR manipulation than using 'R' in Number-In or Number-Out. If 'Clear Presentation Restricted' is activated the map matches only to calls with the presentation restricted set. Together with the 'Verify CGPN' flag at the route this can be used to route calls with CLIR differently.

=== Screening ===

With this the Screening Indicator of the Calling Party Number can be set to 'User provided', 'User provided and verified', 'User provided verify failed' and 'Network provided'. Only used to solve compatibility issues.

== Samples ==

=== !->0 ===

An incoming CGPN is completely replaced by 0

=== 12-> ===

An incoming CGPN of 1234 is changed to 34

=== 12->34 ===

An incoming CGPN of 1234 is changed to 3434

=== 12??->56 ===

An incoming CGPN of 12345 is changed to 565

=== 12??!->56 ===

An incoming CGPN of 12345 is changed to 56

=== R12->34 ===

An incoming CGPN of R1234 is changed to 3434. Only restricted numbers starting with 12 match.

=== 12->R34 ===

An incoming CGPN of 1234 is changed to R3434. Any number starting with 12 matches.

=== 1..->2 ===

An incoming CGPN of 1234 is changed to 2234. Any number starting with 1 matches.

=== 1..!->2 ===

An incoming CGPN of 1234 is changed to 223. Any number starting with 1 matches.

Reference10:General/Admin

2014-04-30T13:07:57Z

Muelbuesch: /* Help URL */ removed typo

Basic parameters for the Administration access of the device are configured here.

== Device Name ==

The name of the device. This name is displayed in the browser as a title. It is also added to the product id sent with outgoing registrations. This way it is displayed e.g. on the registrations page of the PBX.

== User/Password ==

The administrator account. This account can be used for telnet access (if configured) and all password protected pages of the web user interface. By default all pages except Administration/General/Info are password protected. The web server of the device can be configured to protect all pages. The password has to be entered twice.

The password cannot be left empty. If an empty password is entered, the password won't be changed.
The length of the password is limited to 15 characters.

== Additional Administrator Accounts ==

Additional user accounts. These user accounts can have viewer or full administrator privileges.

== Help URL ==

The URL to access the online help. By default an URL of <nowiki>"http://wiki.innovaphone.com/index.php?Title=Reference<major firmware version number>:<page name>"</nowiki> is used. This links to online help pages in the Reference namespace of the innovaphone wiki.

For example on a V9 device configure following Help URL to link to the local wikitogo installation:

<code>http://192.168.0.100:8081/index.php?Title=Reference9:</code>

== Delegated Authentication ==
In v8 devices can delegate authentication of administrative users to an authentication server using Kerberos. To enable remote user authentication the device has to join the realm of an innovaphone Kerberos server. Delegated authentication can only be used with HTTPS.

=== Join realm ===

The server location of the realm has to be configured, first (see section "Authentication Servers").

Click "Join realm" and specify the username and password of an administrator in the target realm to add the device to the remote host database. This works only with innovaphone servers. If you want to authenticate users from a third-party server setup cross-realm authentication.

=== Leave realm ===

An administrator username and password from the realm is needed to deregister from the realm and remove the device from the remote host database. If the server does not exist any longer the registration can be deleted manually.

=== Default user realm ===

This is the default Kerberos realm that shall be used if users log-in without specifying a realm.

\user -> example.com\user
user@ -> user@example.com

If no default user realm is configured, the Kerberos realm of the box is used. So the parameter is only needed if users and devices are members of different realms.

=== Disable local authentication ===

If this option is selected only users from the Kerberos server are accepted. Logins using local administrator accounts will be rejected. Activating this feature together with [[Reference9:Phone/Protect|"Protect configuration at phone"]] option will disable you to make any changes on the phone.

== Authentication Servers ==

The addresses of Kerberos servers have to be configured locally on each host or client device.

If there is no server configured for a realm, the device will try to locate it using DNS. The Kerberos server is looked up in the following SRV record.

_kerberos._udp.REALM ''(e.g. _kerberos._udp.example.com)''

Normally this should work for Windows servers in the LAN.
== Debugging ==
If you have trouble you may want to set <code>config add CMD0 /kerberos-trace</code> (and activate it) on the device you try to log-in to. On the kerberos server (if it is an innovaphone box), you can set the ''Kerberos Server'' check marks in ''Maintenance/Diagnostics/Logging'' and ''Maintenance/Diagnostics/Tracing''. Also keep in mind that kerberos-based authentication is '''only available with HTTPS'''.

Reference10:PBX/Objects/Waiting Queue

2014-04-25T09:36:12Z

Muelbuesch: /* Primary Group/Timeout */ typo removed

The Waiting Queue PBX object is used to put calls sent to this object into a queue. While the call is in the queue, it may either remain in alerting state or it be connected with an announcement played. Two announcements can be configured played one after the other, the second is repeated. Calls which are in the queue can be sent to groups of operators configured for the queue. Calls are strictly sent in a first in first out manner to operators. The next call is sent only after the previous call is connected. Destinations can be configured, which can be dialed using DTMF while a call is in the queue and connected.

'''The Waiting Queue PBX object does not support DTMF tone detection. Only 'telephone-event' (RFC-2833) or DTMF signalling (H.245 User Input Indication / SIP INFO(dtmf-relay)) are supported.'''

== Configuration ==

=== Addressing ===

The Long Name, Name Number and Node configuration parameters have the same meaning as for any other object.

=== Registration ===

Hardware ID, PBX, Send Number, Password, Filter, Diversion Filter and Group Indications are used only for endpoints registered directly to the Waiting Queue object. This maybe useful to set diversions for the Waiting Queue object and such endpoints can be used to make calls and are treated as operators of the Waiting Queue.

=== CFNR Timeout ===

The timeout used for call forward no response. See Diversions.

=== Busy On ... Calls ===

This configuration parameter can be used to limit the calls in the queue. Calls connceted to a operator do not count in this respect anymore.

=== Announcements ===

For announcements the URL and/or Extern Name/no have to be configured. If no Extern Name/no is configured the local HTTP interface is used to retrieve the announcements. The URL has the following format:

<nowiki>http://<addr>/<filename.$coder>?coder=<coder-list>[&repeat=true|repeat=n|disc=true|random=true|record=true]</nowiki>

{|
|valign=top nowrap=true|'''addr'''
|The IP address of the web server. A DNS name cannot be used here.
|-
|valign=top nowrap=true|'''filename.$coder'''
|The filename of the announcement files including any path. $coder will be replaced by the actual coder used.
|-
|valign=top nowrap=true|'''coder-list'''
|A comma seperated list of all available coder. For each coder in the list the respective announcement file must be available on the server. The available coders are g729,g711a,g711u,g723.
|-
|valign=top nowrap=true|'''repeat=true'''
|If this is present the announcement will be repeated. If this is used for the 1st Announcement the 2nd Announcement will never be played.
|-
|valign=top nowrap=true|'''repeat=<n>'''
|If this is present the announcement will be repeated another n times.

|-
|valign=top nowrap=true|'''fallback=true'''
|If this is present and the specified announcement file is not available, the built-in MOH pattern will be played.
|-
|valign=top nowrap=true|'''random=true'''
|If this is present, the announcement will be started at a random offset, so each caller will hear it from a different point in time. This works with non-local URLs only though.
|}

Example

<nowiki>http://145.253.157.2/announce/welcome.$coder?coder=g711a,g711u,g729</nowiki>

If no URL is configured the local HTTP interface plays the built-in music on hold by default.

If an Extern Name/No is configured then no local HTTP interface is used, but a call is sent to the configured Name/No. The URL is sent with this call as user-user-info, so that a remote HTTP interface can use it the same way as the local HTTP interface. As destination of the call any voip endpoint can be used.

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

There are 2 pseudo URLs available, TONE and MOH. Such URLs will be interpreted locally and connect to the systems tone and music-on-hold interface, respectively.

{|
|valign=top nowrap=true|'''TONE'''
|as URL will produce a constant tone (often recogonized as a dial-tone). You can add a '''?tone=ringback''' which will give you a tone sequence with 1 second tone and 4 seconds silence (this is often recognized as a ring-back tone).

You can also add a '''?tone=busy''' which will give you a busy tone sequence. Notice that the queue is only playing the busy tone, it will not disconnect the call. (To disconnect the call after a while, use the CFNR to a not existing user or to a Disconnect user object, routed to the DISC interface.)
|-
|valign=top nowrap=true|'''MOH'''
|will produce the built-in music-on-hold. Please note that both TONE and MOH never end, so '''repeat=true''' is not required and '''disc=true''' will have no effect.
|}

'''V7 hotifx9''': At any location inside the URL placeholders can be used, which are replaced by a string defined for the placeholder. The following placeholders are available:
{|
|valign=top nowrap=true|'''#p'''
|Position of this call within the queue. '''0''' means the next available operator will answer this call.
|-
|valign=top nowrap=true|'''##'''
|Is replaced by '''#'''
|}

Example

<nowiki>http://145.253.157.2/announce/queue_place#p.$coder?coder=g711a,g711u,g729</nowiki>

will be resolved to the files ''queue_place1.g711a'',''queue_place2.g711a'', ''queue_place3.g711a''...., depended on place in queue. So you have to create one set of prompt files for each queue place.

'''Recomended solution:''' Create a ''welcome'' prompt in 1st Announcement and a ''queue_place'' prompt (witch will be repeated) in 2nd Announcement. This way the every time the 2nd Announcement it's repeated it will provide the queue position to the caller.

=== Max Call/Operator(%) ===

This configuration parameter allows to limit the number of current calls depending on the number of operator registrations in the primary group. Only the configured percentage of operator registrations are accepted as calls. Calls currently connected to operators do count in this context. For example if 2 operators are registered and the value is set to 150%, the 4th call received will get a busy. Note that only operators in the primary group count for this, this means if there is no primary group configured all calls are rejected with busy if any value is entered here.

=== Alert Timeout ===

The timeout (in seconds) after which the Waiting Queue connects incoming calls. If no timeout is configured the Waiting Queue will never connect. If a timeout of 0 is configured the Waiting Queue connects right away.

=== Round Robin Timeout ===

If a round robin timeout is configured the call is not sent to all members of the primary group at the same time, but it starts with one only. After the round robin timeout has expired, the call is sent to all members of the primary group. The operator used for the first call changes in a round robin mannor. If the checkmark '''Speedup if more calls waiting''' is set, the round robin timeout will be reduced as soon as a second call arrives.

=== Primary Group/Timeout ===

The call is sent to this group first, either to all members at the same time, or in a round robin manner. After the configured Primary group Timeout expires the call is sent to all operators. If Primary group operators are busy the call is immediately sent to Secondary Groups members. Operators are all members of groups in which the Waiting Queue object itself is active member. The operators do not need to be active members of these groups.

=== Support for RTP-DTMF ===

If the announcement interface for a Waiting queue is not the PBX internal one and the calling endpoint can only do RTP-DTMF, the announcement interface receives the RTP-DTMF and not the waiting queue. When this checkmark is set, the '''uui-dtmf=on''' argument to the URL is added, which tells the announcement interface to send back the received DTMF as USER-INFO.

This feature is needed for a Hosting Scenario where the PBX is located in a private network and the Media interface on a different system in the public network.

=== Operator connect for SOAP ===

On the SOAP/TAPI interface a call to a waiting queue is normally indicated as connected as soon it is connected signalingwise, this means it is indicated as connected if an announcement is played. This behaviour can be changed so that it is indicated connected only after an operator has accepted the call by setting this checkmark.

=== Call busy Operators ===

Normally an operator who is already engaged in a Waiting Object call is not called again. If this checkmark is set, calls are delivered to these (busy) operators as well.

=== CFU disables Operator ===

If this checkmark is set a operator which has a CFU set is not called.

=== No Mobility for Operators ===

If this checkmark is set, mobility for operators is not executed.

=== Announcement w/o Connect ===

If this checkmark is set, no connect is sent on incoming calls to play the announcements. This feature allows to provide free-of-charge waiting queues. For this to work, the carrier has to support early media (and not all do, for example German Telekom is known to not support this feature as of December 2012 on ISDN lines). On TE ISDN interfaces the Annex-N option has to be enabled for this.

=== Presence Disables Operator ===

If this checkmark is set, no calls are sent to an operator with presence information set.

=== Set Operator Presence ===

If this checkmark is set the presence of an operator is set to busy whenever the operator accepts a call. A timeout can be set after which this presence information is cleared again after the call release.

=== DTMF destinations ===

A list of DTMF destinations can be configured. Any DTMF digits dialed after the call is connected to an announcement is matched to this list. If a match is found the call is sent to Dest. No/Dest. Name. If no Dest. No/Dest. Name is configured more DTMF digits may be dialed for the final destination. If the destination of the call is not an endpoint, but a gateway (Trunk object, Gateway object), the call is sent only after a timeout of 4s after the last digit is dialed.

A '.' entered as DTMF map will catch all DTMF digits dialled after this map and append them at the end of ''Dest. No''.

Example
DTMF Dest. No Description
55. 11 if the DTMF sequence "55222" is dialled, the destination number is "11222"
. <empty> the dialled DTMF sequence is passed completely to the destination

A '~' character before the DTMF destination indicates that no ct_complete shall be generated. This means the dialed DTMF destination does not show up in the redial list of the phone.

== Call Forwarding ==

Call Forwarding can be used with the Waiting Queue object and can be set/reset by endpoints registered to the Waiting Queue object itself.

{|
|valign=top nowrap=true|'''CFU'''
|Executed as usual
|-
|valign=top nowrap=true|'''CFB'''
|Executed if the Busy on ... calls condition or the Max Call/Operator(%) condition applies.
|-
|valign=top nowrap=true|'''CFNR'''
|Executed if the CFNR timeout expires and no operator has accepted the call, even if the call is connected to an announcement or if the first announcement ends and no second announcement is configured.
|}