Howto:Configure the innovaphone Voicemail

2009-07-14T12:29:38Z

HartmutMueller:

The innovaphone voicemail (VM) is implemented as a PBX object.
An answering machine can be assigned to each PBX user.
The VM is script-driven and controlled by means of DTMF touchtones.
It features a built-in WebDAV client, enabling the VM to communicate to an external WebDAV server, which serves as the mass-storage for audio files, script files and user-directories.
The VM script and pre-recorded audio files are subject to be provided by innovaphone.
Message Waiting Indication (MWI) is supported.

==Applies To==
This information applies to

* innovaphone PBX, V6
==More Information==

===System Requirements===
Voicemail license: The innovaphone voicemail requires licensing. The number of acquired voicemail licenses must be equal or greater than the number of PBX basic licenses.

WebDAV server, e.g.: Apache 2.x, IIS W2K, IIS W3K, or with V6 sr1 the compat flash drive (no external WebDAV server needed)

Innovaphone will provide you with an XML script, that represents the actual voicemail. In addition you will get a set of files with *.g711a, *.g711u and *.g729 extensions. These files contain the audio snippets and the menu prompts, that the voicemail requires.

==Installation, WebDAV==
A few preconditions are assumed as basis for the following few installation and configuration steps:

* The number of the VM object is 66.

* The number of a sample user test is 49.

* The IP address of the WebDAV server is 192.168.0.5.

* The root directory, that contains the VM script and the pre-recorded audio files is c:\Inetpub\webdav\vm\en which corresponds to the URL http://192.168.0.5/webdav/vm/.

* The file name of the voicemail XML script is vm.xml.

===Creating the Voicemail Object===
Proceed to Administration/PBX/Objects.
*Select Voicemail from the drop-down list and click on new.
*Enter Long Name, Name.
*Enter 66 as Number.
*Enter the Script URL as http://192.168.0.5/webdav/vm/vm.xml.

===Distributing the Voicemail Script and Pre-Recorded Audio Files===
Download the installation program for the ''innovaphone voicemail'' from the [http://download.innovaphone.com innovaphone download area].

Could be much easier to find this stuff... there seems to be no version within v7- nor v8-Folder
Is this product discontinued? ;-)

Start the installer program (innovaphone-voicemail-install.exe).

The installer will be asking for a target directory. Enter ''c:\Inetpub\webdav\vm\''.
Now, the installer will copy all of the localized voicemail files into language specific sub-directories. The english files will remain under the absolute path ''c:\Inetpub\webdav\vm\en\''.

===Configuration===
Please note, that a user's VM number is the number of the VM object, that you assigned here, plus the user's number.

Example: If a user has the number 49 and the number of the VM object is 66, then the user's corresponding VM number will be 6649.

===IP Phone Configuration===
====V6, SR1: Recommended Configuration====
A user may wish to manually activate or deactivate a CFU diversion to his VM.
* Browse to the IP phone of the user 49:test:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Call Forwarding'' and click on ''new''.
* A new window will open. Enter ''AM-on'' under ''Idle State/Text''.
* Enter AM-off under ''Active State [1]/Text''.
* Enter ''6649'' into ''Active State [1]/Text/Always/Number''.
* Click on ''OK''.

An additional function key is required to present the MWI and to quick-dial the VM:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Message Waiting'' and click on new.
* A new window will open. Enter ''AM'' under ''Idle State/Text''.
* Select the ''letter'' icon under ''Active State/Icon''.
* If you desire, then choose ''LED/blink''.
* Enter ''6649'' into ''Message Center Account/Number''.
* Click on ''OK''.

====V6, SR2: Recommended Configuration====
The SR2 configuration adapts to mass-deployment requirements, in such that the set of required configuration parameters can be distributed identically among all affected phones.

A user may wish to manually activate or deactivate a CFU diversion to his VM.
* Browse to the IP phone of the user 49:test:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Call Forwarding'' and click on ''new''.
* A new window will open. Enter ''AM-on'' under ''Idle State/Text''.
* Enter ''AM-off'' under ''Active State [1]/Text''.
* Enter ''66'' into ''Active State [1]/Text/Always/Number''.
* Click on ''OK''.

An additional function key is required to present the MWI and to quick-dial the VM:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Message Waiting'' and click on new.
* A new window will open. Enter ''AM'' under ''Idle State/Text''.
* Select the letter ''icon'' under ''Active State/Icon''.
* If you desire, then choose ''LED/blink''.
* Enter ''66'' into ''Message Center Account/Number''.
* Activate the ''Append Own Number'' checkmark.
* Click on ''OK''.

====Deploying the MWI Function Key By An Update Script====
From on V6,SR2 the MWI key configuration can be designed to be applicable for all phones. The following excerpt shows how the resulting configuration line would look alike for our example.

mod cmd PHONE USER-UI/0 fkey-edit /id 0 /fkey_id 0 /fkey_type mwi /label mwi-off /icon letter /mwi.label mwi-on /mwi.icon letter-black /mwi.led blink /mwi.e164 66 /mwi.ext on /op OK

* ''/mwi.e164 66'' defines the MC number ''66''
* ''/mwi.ext on'' activates the ''Append Own Number'' checkmark

===Webserver Aspects===
WebDAV in Common: As stated above, WebDAV is required for the VM to work.

What is WebDAV? In its long form it reads "Web-based Distributed Authoring And Versioning" and is specified in RFC2518.
Technically is WebDAV a set of protocol extensions to the HTTP protocol.
These extensions allow for some file i/o operations,that aren't covered by HTTP:
*Renaming, moving, copying a file file.
*Properties: That is, information retrieval about a certain file. E.g. the file creation time.

===Webserver Authentication===
If HTTP Authentication is required, configure a triple of ''URL,User,Password'' underneath ''Configuration/General/HTTP-Client''.

In our example ''http://192.168.0.5/webdav/'' may be entered as ''URL''. Every URL that head-matches this URL and requires authentication will be authenticated with the user,password provided here.

===Apache Webserver 2.x===
The Apache supports WebDAV from on version 2.0 natively.

However, WebDAV must be enabled to be run. Please find the respective documentation page at apache.org under http://httpd.apache.org/docs/2.0/mod/mod_dav.html .

Test Environment: Our test environment was a RedHat Linux 8.x.
The configuration file for httpd resides under /etc/httpd/conf/httpd.conf .
The voicemail is located underneath /var/www/webdav/vm/.

Open httpd.conf with a text editor.
*Ensure the modules required for WebDAV are being loaded
<code apache>
LoadModule dav_module modules/mod_dav.so
LoadModule dav_fs_module modules/mod_dav_fs.so
</code>

*Ensure, that WebDAV is enabled and that an alias is being created for webdav
<code apache>
Dav On
Alias /webdav "/var/www/webdav"
</code>

*In our test environment we didn't restrict access to the webdav directory
<code apache>
Options Indexes MultiViews
Allow from all
</code>

An important aspect is the fact, that we had to apply chmod -R 766 to the /var/www/webdav directory. chmod -R 666 didn't suffice.

Without doing so, i.e. granting the read-/write-/execute-access, we received Forbidden responses when e.g. trying to read the filenames within a directory.

A potential delay source can be reverse DNS lookups. A webserver is trying to retrieve a DNS name for every source address it receives requests from. The drawback is, that every HTTP request is being delayed by the amount of time it takes to complete the reverse DNS lookup.

Within httpd.conf we therefore wrote ''HostNameLookups Off'', in order to avoid DNS requests for logging purposes.

Please note further that access restrictions with DNS names, instead of IP addresses, will
bypass this setting, i.e. will make the ''HostNameLookups Off'' -setting ineffective.

===Microsoft Internet Information Server (IIS), W2K===
As a testbed an IIS 5.0 was utilized on a Windows 2000 server. By default WebDAV is already enabled within IIS 5.0. However, no data is published.

*To publish data simply.
Create a new virtual directory webdav within the default website by means of the IIS Admin. Allow read, write and browse operations being executed on that directory and underneath.
Use the Windows Explorer to modify the security settings of the directory (and underneath) and set it to full access for everyone (It is left up to the Windows experts how to restrict this further).

===Microsoft Internet Information Server (IIS6), W2003 ===
In contrast to Windows 2000 Server, Windows Server 2003 does not come with WebDAV being already enabled. In addition File extensions with *.g711a, *.g711u and *.g729 must be configured as a new Mime-Type. You must enable WebDAV from within the IIS Admin first. Files with the extension *.g711a, *.g711u and *.g729 will not be returned.

*You must add *.g711a, *.g711u *.g729 as a Mime-Type, otherwise the audio files won't be accessible.
Pls. see: MS KB article Q326965 http://support.microsoft.com/kb/326965/en-us ,respectively http://support.microsoft.com/kb/326965/de-de for how to do this.

Browse to http://192.168.0.5/webdav/vm/ and try to download a g711a-file and a g729-file from within your browser. This step will prove, that the Mime-Types were successfully added.

'''Note:''' After the new Mime-Types were added an IIS6 restart seemed to be a MUST.

===innovaphone own WebDav Server (Compact flash card slot)===
Please see [[#Installation, CompactFlash Card|Installation, CompactFlash Card]] below.

===Testing WebDAV Access===
From within the Windows Explorer go to Tools/Map Network Drive.
*Select Web folder or FTP site.
*Enter the URL http://192.168.0.5/webdav/ and proceed.

Now you may test whether you can read files, write files, delete files, create directories.

===User-Related Files And Directories===
Our sample user has the number 49 and the name test. When this user calls his box 6649 for the first time, the VM will create a directory for him and underneath a pair of additional directories. The new directories for the user test are:

*…/webdav/vm/test/. New voicemails will be copied here.
*…/webdav/vm/test/personal. The personal greeting message resides here.
*…/webdav/vm/test/store. When a message is stored, it is copied into this location.

If the directory creation fails, the call to the VM will be forcedly disconnected.

===PIN Administration===
Initially, there is a default PIN active. When being asked for a PIN, enter 8765.

The PIN can be changed by means of menu option 4.

The PIN can be reset administratively to the default by just deleting ''.../personal/pin.txt'' within a user's directory.

===URL Query String Variables===

URL Query String Variables are generally passed on to a script.

The following variables control the script's behaviour and may be applied within the configured script-URL alike: http://192.168.0.5/webdav/vm/vm.xml?$_nopin=true.

Multiple variables can be combined by an ampersand (&) alike: http://192.168.0.5/webdav/vm/vm.xml?$_nopin=true&$_pbxcoder=g711a.

* $_nopin. Controls, whether a PIN must be entered.
**true: Voicemail owner doesn't need to enter a PIN when calling from his extension.
**false (default): A PIN must be entered
(Note: A PIN must always be entered when calling from "foreign" extensions)

* $_pbxcoder. Allows to restrain the offered coder list, when executing <pbx-prompt> for files with "*.$coder" extensions.
** The internal default is: $_pbxcoder=g729,g711a,g711u,g723

* $_pbxfwd
** true: diversions will be executed on <pbx-fwd>
** false (default): diversions won't be executed on <pbx-fwd>

* $_pbxmwidir. Allows to configure a parent directory for all user sub-directories and for all MWI operations. As default there is no such directory active.

* $_pbxremhold
** true (default): Rules whether caller will be sent a REMOTE-HOLD while executing <pbx-fwd>.
** false: No REMOTE-HOLD is sent

* $_trace, decimal number: Controls verbosity of tracing outputs. The following values can be added. Everything can be traced by simply entering 255 (i.e. ''$_trace=255'').
** 1: errors, 2: interpreter, 4: parsing, 8: code, 16: store operations, 32: http operations (during <exec>), 64: <debug> statements, 128: webmedia

==Installation, CompactFlash Card==
Instead of using a WebDAV server you may want to use the local CompactFlash card as mass storage device. This section outlines how this can be accomplished.
=== Installing the Voicemail on a CompactFlash Card ===
Please see the article [[Howto:Installing the voicemail/music on hold on a compact flash card|Howto:Installing the voicemail on a compact flash card]].

The aforementioned configuration scenario, within the above chapter: [[#Installation, WebDAV|Installation, WebDav]], does also apply for an installation on a CompactFlash card. Please, refer to that chapter if you look for informations on how to generally configure a basic voicemail scenario, including the affected ip phone configuration.

==Advanced Configuration==

===Sending of additional MWIs===
* [[Howto:How To Send Additional MWIs within a PBX|How To Send Additional MWIs within a PBX]]
The article deals with the question how a single voicemail box can be shared among a few users.
===Custom Personal Announcement===
* [[Howto:Deploy A Custom Personal Announcement For the innovaphone Voicemail|Deploy A Custom Personal Announcement For the innovaphone Voicemail]]
Explains where to copy an externally generated personal announcement file.
===A Simple Recording Solution On-Top of The innovaphone Voicemail===
* [[Howto:A Simple Recording Solution On-Top of The innovaphone Voicemail|A Simple Recording Solution On-Top of The innovaphone Voicemail]]
This article explains how a simple recording solution could be set up on-top of an innovaphone Voicemail.
===Send Email MWI Notification From The innovaphone Voicemail===
*[[Howto:Send Email MWI Notification From The innovaphone Voicemail|Send Email MWI Notification From The innovaphone Voicemail]]
This functionality is available from on SR2 and allows to send MWI notifications by email.

==Quick Reference For innovaphone Voicemail==
* [[Howto:Quick Reference For innovaphone Voicemail|Quick Reference For innovaphone Voicemail]]
The article outlines the menu structure and provides a few operational hints from a user's perspective.

==Known Problems==
The VM makes use of V6’s media negotiation capabilities.
This is why V5 endpoints are not supported.

[[Support:Voicemail Calls Hanging Around In PBX Call Monitor|Support:Voicemail Calls Hanging Around In PBX Call Monitor]]

[[Support:Voicemail: Voicebox Not Configurable With "Send Number" set|Support: Voicemail: Voicebox Not Configurable With "Send Number" set]]

* When you first start the mailbox of an IP Phone, in the object of the IP Phones does no "send Number" configured. Once the mailbox was configured, the entry "send Number" can be configured.

[[Support:Voicemail Fails With "Missing Voicemail License!"|Support:Voicemail Fails With "Missing Voicemail License!"]]

[[Support:Voicemail Fails With "Authentication Required"|Support:Voicemail Fails With "Authentication Required"]]

== Related Articles ==

===Voicemail Installation===

[[Howto:How to setup an V6 IP Phone for innovaphone voicemail usage]]

[[Howto:Send Email MWI Notification From The innovaphone Voicemail]]

[[Howto:Quick Reference For innovaphone Voicemail]]

===Voicemail on Compact Flash===

[[Howto:General information for compact flash cards]]

[[Howto:Installing the voicemail/music on hold on a compact flash card]]

===Voicemail Customising===

[[Howto:Deploy A Custom Personal Announcement For the innovaphone Voicemail]]

[[Howto:Does innovaphone voicemail support multiple announcements?]]

[[Howto:How To Send Additional MWIs within a PBX]]

===Voicemail Scripting===

[[Howto:Getting started with your own PBX voicemail script]]

[[Howto:A Simple Recording Solution On-Top of The innovaphone Voicemail]]

[[Howto:Voicemail Scripting And Projektcode, PIN, Auth Code]]

[[Howto:Simple ACD with Voicemail XML Script]]

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

Reference:Administration/Gateway/CDR0

2009-07-14T11:49:58Z

HartmutMueller: Syslog doesnt know "Classes"

The transmission of the so-called '''CDRs''' (Call Detail Records) is disabled as standard (Off). After selection of a CDR type, the transmission of detailed CDRs is enabled, as are the relevant entry fields. To prevent data loss in the event of failure of the first CDR server (CDR0), it is possible to specify a second CDR server (CDR1).

* '''Off:''' CDR is disabled.
* '''TCP:''' The device transmits the CDR entries via a TCP connection.
** In the Address field, you enter the IP address at which the TCP connection is to be set up.
** In the Port field, you specify the port to which the connection is set up.
* '''SYSLOG:''' The CDR entries are transmitted to a syslog recipient (also referred to as syslogd, syslog server or syslog daemon ), which is then responsible for their further evaluation or storage.
** In the Address field, you enter the IP address of the syslogd server.
** In the Class field, you enter the desired message class that will be responsible for further processing of the CDR entries.

Syslog does not use a "Class" - it uses "Facilities" or "Severities" - no "Classes"
So what is meant by "class"?

* '''HTTP:''' The CDR entries are transferred to a Web server, where they can be further processed. Each individual CDR entry is transferred as form data to the Web server in HTTP GET format.
** In the Address field, you enter the IP address of the Web server that carries out further processing of the transmitted data.
** In the Path field, you enter the relative URL of the form program on the Web server.<br>The device will make a HTTP GET request to the Web server on the entered URL, followed by the URL-encoded CDR entry. If, for example, a page named /cdr/cdrwrite.asp with a form that expects the log message in parameter msg exists on a Web server, then the value /cdr/cdrwrite.asp is entered. The device will then make a GET /cdr/cdrwrite.asp?event=syslog&msg=logmsg request to the Web server.
* '''LOCAL:'''The CDR entries are transmitted to the local Compact Flash card. This will be place on the CF card where the CDR`s are stored \\Ipaddress\drive\CF0\log
**In the Max File Size filed , you create a size when a new file should be created.
**In the Backup Time filed, you enter a time/date when a new file should be created.

innovaphone wiki - User contributions [en]

Howto:Configure the innovaphone Voicemail

Reference:Administration/Gateway/CDR0