innovaphone wiki - User contributions [en]

Howto:FACT24 - F24 AG - 3rd Party Product

2024-03-13T12:29:30Z

Massimo95: /* Configuration */ Lesbarkeit verbessert, Rechtschreibfehler korrigiert.

[[Image:Serinus Logo RGB-digital blue.png||200px|right]]

==Product Name==
FACT24 Mediagateway | FACT24 ENS+ [https://fact24.f24.com/de/fact24-ens-hybrid/]

==Certification Status==
{{Template:Compat_Status_"referral_prod."|certificate=Serinus_-_serinus_-_3rd_Party_Product_product_cert.pdf}}

Testing of this product has been finalized May 2nd, 2019.

==Category==
{{Category:3rdParty Alarm Server}}
[[Category:Referral Product|{{PAGENAME}}]]
[[Category:3rdParty Alarm Server|{{PAGENAME}}]]

==Vendor==
[[Image:logo_F24.png]]

F24 is Europe’s leading Software-as-a-Service (SaaS) provider for resilience. More than 5,500 customers worldwide rely on their digital solutions, which support companies and organisations through all areas of resilience. Solutions cover business messaging and service notification, emergency and mass notification, incident and crisis management, as well as governance, risk and compliance.
The integrated FACT24 solution supports you in operating a holistic emergency and crisis management system. The system enables fast, multimedia communication and intervention in emergencies and critical situations. In addition to pure SaaS solutions, F24 also offers classic on-premises alerting solutions, as well as a combination of both worlds. F24's hybrid approach allows the use of a central alarming solution that combines the flexibility of the cloud with the added value of a local alarm platform.

[https://f24.com/de/ F24 AG]

==Description==
[[Image:Product_Hybrid.png|600px]]

FACT24 ENS+ Hybrid provides a central alerting and crisis management solution that combines cloud flexibility with the added value of a local alerting platform. You’ll get the flexible and low-maintenance operation of FACT24 ENS+ SaaS and the extended connectivity options of FACT24 ENS+ On-Premises. This means you can connect local subsystems, such as fire detection systems, via numerous interfaces using alarm media gateways. You have the flexibility to distribute alarms locally or via the cloud, depending on the application.

'''Benefits at a glance:'''
* Rapid scalability via the cloud, e.g. in case of multimedia mass notification
* Process-oriented configuration and operation of alerts and conferences
* Multi-client rights and role concept
* Central monitoring and administration of all mediagateways, even at different locations, via a central web console
* Additional, multimedia alerting resources
* Flexible cloud connectivity options and local resources, e.g telephone or fire detection system
* Failure protection via geo-redundant cluster operation and redundant network connections
* Hosted in German high-security data centres (including certified ISO/IEC 27001:2013, ISO/IEC 20000-1:2018 and ISO 9001:2015)

==== Available Languages====
* German
* English

==Functions==

A lightning strike in the data centre, flooding in your region, an emergency case in the production line – whenever the worst case scenario occurs,
it is important to be prepared. According to a defined set of rules, Serinus transmits alarms using all the available communication channels,
while informing users about certain events and which responses are expected from them. Through the confirmation function, Serinus receives a qualified feedback on the availability and response times of your teams. All alerting operations are logged in detail and can be used for process improvement.

'''Key features in combination with Innovaphone:'''

* Display text on Deskphones and Dect-Phones
* Confirmation via DTMF ( positive, negative, PIN-based, Time)
* Textmessage via SOAP Interface
* Loudspeaker broadcast
* Control call forwarding
* Call intrusion
* Call recording
* LDAP Integration Innovaphone to import User
* Localisation

'''Offered Interfaces'''
* Digital contact inputs and outputs
* Serial connections via ESPA 4.4.4
* IP integration via ESPA-X, KNX, Modbus, BACnet
* Connection through OPC
* REST API Interface
* Email
* SMS
==Use Cases==
'''Alerting'''
* [https://f24.com/en/solutions/alerting-software/ Successful Alerting with an Alerting Software ]
* [https://f24.com/en/solutions/evacuation-alarm-in-crisis/ Fire and evacuation alert ]
* [https://f24.com/en/solutions/silent-alarm-for-emergency-management/ Silent alarm ]
* [https://f24.com/en/f24-whitepaper-alerting-and-crisis-communication/ Alerting and crisis communication ]
* [https://f24.com/en/solutions/mass-notification-solutions/ Mass Notification System ]

'''Crisis management'''
* [https://f24.com/en/it-incident-management-en/) IT Incident Management ]
* [https://f24.com/en/product-recall-management/ Product recall ]
* [https://f24.com/en/f24-whitepaper-incident-management/ Incident Management ]
* [https://f24.com/en/solutions/business-continuity-management/ Business Continuity Management ]
* [https://f24.com/en/solutions/media-management-during-crisis/ Media Management & Communications ]

==Version==
Product versions used for interop testing:
* Fact24 Mediagateway Version 2.2.16/2.2.13/2.2.8/2.1.x/2.0.x/1.1
* innovaphone V13 R1 SR5 IPVA 13.2075 / V12 R2 SR17 IPVAC 12.5.3.717

==Setup==

'''SIP configuration with Mediagateway (Version 2.2.x and higher)'''

There are two ways on how to connect the Serinus Mediagateway to a Innovaphone PBX :

- Establighing the connection as an'''(SIP-) object''', which is easy and fast but does not have many configuration possibilities.
- Connecting the Serinus Media Gateway as an '''gateway trunk''', which has much more possibilities like codec selection, routings, etc.

In both ways calling the mediagateway through an range of numbers is possible (e.g. 99 000-999).

The decision of which method to choose should be made by the technician responsible for supporting the telephone system.

The following steps outline the preferred method for configuring a connection as a '''gateway trunk''', due to its advanced configuration options.

===SIP configuration as Gateway Trunk===

Heres an overview of the SIP connector in the Mediagateway (example).

[[Image:F24AG_Connector_overview.png]]

This example shows how the mediagateway can be connected.

Here we used the following configuration examples:

Serinus Mediagateway: 192.168.8.25

Innovaphone PBX: 192.168.8.171

TelNbr Mediagateway: 71-xxxx

===Gateway trunk connection===

[[Image:Serinus - Serinus GmbH - 3rd Party Product_1_EN.PNG]]

These image shows the gateway object Serinus_Mediagateway71 No 71.

As soon as all configuration steps are made in the innovaphone pbx, the gateway object and the GW from the menue GK will connect to each other.

[[Image:Serinus - Serinus GmbH - 3rd Party Product 2 EN.PNG]]
[[Image:Serinus - Serinus GmbH - 3rd Party Product 3 EN.PNG]]

Create a new gateway object.

On the innovaphone configuration page go to: Gateway - GK - GW1

[[Image:Serinus - Serinus GmbH - 3rd Party Product 4 EN.PNG]]

[[Image:Serinus - Serinus GmbH - 3rd Party Product 5 EN.PNG]]

Enter the details as shown above. Use Protocol TCP, Remote Domain is this own PBX (!). For autorization use the credentials of the prior created Gateway object. Under "Alias List", enter the name and the number of the above created gateway object. Select the codec G722. Use no encryption.

[[Image:Serinus - Serinus GmbH - 3rd Party Product 16 EN.png]]

If more than one pbx system or Mediagateways are connected, you can add a route to allow calls between them.

To create a new SIP connector on the Serinus Mediagateway go to Menue - connectors - new SIP Connector.

[[Image:F24AG_Connector_Basic_Settings.PNG]]

Add a connection name, the serveradress of the innovaphone pbx, the portnumber, the protocoll and the authentication details

After adding the connection details you can start a testcall to a telephonenumber through entereing the phone number and pressing the button "call".

The "send message" button can be used with some pbx systems to send a SIP-textmessage.

[[Image:F24AG_Connector_SIP_Extended_Settings.PNG]]

[[Image:F24AG_Connector_Extended_Settings.PNG]]

The extended SIP logging can be activated already at the beginning to have a better overview through the logfiles if connection problems may occure. It must be deactivated afterwards to prevent performance problems.

"Take incoming call before reject or go further" can optionally be activated if the function "silent alerting" will be used. This can prevent the telephone from playing a short dialtone when the silent alert key is pressed.

The pbx-prefixes:

[[Image:F24AG_Connector_PBX_Prefixes.PNG]]

===SOAP connection===

The SOAP connection is used for forced release or loudspeaker announcements.

Create a new user in the innovaphone pbx:

[[Image:Serinus - Serinus GmbH - 3rd Party Product 9 EN.PNG]]

[[Image:Serinus - Serinus GmbH - 3rd Party Product 11 EN.PNG]]

The rights should be adjusted to control all affected system phones.

[[Image:Serinus - Serinus GmbH - 3rd Party Product 10 EN.PNG]]

Once done, go back to the mediagateway SIP connector and add the credentials.

[[Image:F24AG_Connector_Special_PBX_Functions.PNG]]

When all settings are correct, the test button will show up a positive confirmation.

If it always fails, please try a password with less than 16 signs.

Enter an not as telephone entry already configured number for intruded incoming calls. This number will be called by phones. The Prefix in the SIP connector will be dialed before that.

[[Image:F24AG_Alarm_Manager_Settings_1.PNG]]

Settings for automatic call answer on system phones.

[[Image:F24AG_Alarm_Manager_Settings_2.PNG]]

Settings for forced release on nearly all phones (system phones, sip phones and also system dect phones).

==Summary==
Test Report Serinus

[[Media:Zertifikat_Serinus_und_innovaphone_19032019.pdf]] <br>
[[Media:Zertifikat_Serinus_und_innovaphone_19032019_EN.pdf‎]]

'''Remark innovaphone AG''':
* above listed "certificates" and test reports have been created by manufacturer itself and not by innovaphone itself.
* innovaphone has not conducted any tests nor can confirm functionality as indicated by manufacturer.

==Contact==
{|
| F24 AG
|-
| Ridlerstraße 57
|-
| 80339 München
|-
| Deutschland
|-
| Telefon: +49 89 2323638-0
|-
| Mail: [mailto:sales.partner@f24.com sales.partner@f24.com]
|}

User:Massimo95

2024-03-12T10:36:13Z

Massimo95: Created blank page

Howto:Configure the innovaphone Voicemail

2024-03-12T10:34:10Z

Massimo95: /* Known Problems */

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 and Higher

==Supporting The innovaphone Voicemail==
===Tracing===
For a decent supportable trace
*Activate the '''trace''' checkmark within the UI of the voicemail object
*Append the parameter '''$_trace=251''' to the configured script URL, alike so: <code>https://1.2.3.4/drive/CF0/de/vm.xml?$_trace=251</code>
*Activate the '''PBX''' checkmark within the [[Reference13r3:Maintenance/Diagnostics/Tracing]] page

==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, *.g722, *.opus-wb, *.opus-nb 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.
**'''Note:'''Meanwhile it is recommended to enter it as: http://192.168.0.5/webdav/vm/vm.xml?$_pbxfwd=true (see [[#URL Query String Variables]])

===Distributing the Voicemail Script and Pre-Recorded Audio Files===
The download section offers ZIP files and a Windows installation program. See [[#Download]] for how to find the download site.
* ZIP files
**Download the ZIP file for the language your are interested in (e.g. ''vm-de'', ''vm-en'', ...) from the ''apps'' package on the [http://download.innovaphone.com/ice/6.00/ innovaphone download area, V6 Apps].
**Un-ZIP the file. This step creates a language specific sub-directory that may be copied onto the CF-card.
* Windows installation program
**Download the installation program for the ''innovaphone voicemail'' from the [http://download.innovaphone.com innovaphone download area].
**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
<syntaxhighlight lang="apache">
LoadModule dav_module modules/mod_dav.so
LoadModule dav_fs_module modules/mod_dav_fs.so
</syntaxhighlight>

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

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

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.

===Microsoft Internet Information server (IIS7)===
Two possibilities for authentication are available.

====HTTPS With Basic Authentication====
IIS7 does NOT support HTTP ''Basic Authentication'' without HTTPS/TLS. Therefore it is mandatory to run WebDAV towards the IIS7 on HTTPS and not on HTTP.
*Within the Voicemail object a "<nowiki>https://..</nowiki>"-URL must be configured.
*Under ''General/HTTP/Client'' a user/password tupel must be configured for the "<nowiki>https://..</nowiki>"-URL.
*Within the IIS Admin it must be ensured that ''Basic Authentication'' is allowed.
*Try calling the voicemail object. The request for the voicemail script is going to fail.
*Watch out for a rejected certificate under ''General/Certificates'' and trust that certificate.
*Try calling again the voicemail object. This time the request for the voicemail script should be succeeding.

====HTTP With Digest Authentication====
{{FIXME|reason="Information is vague. Practical confirmation needed. Detailing needed."}}
A user account must be configured within the Active Directory to allow it's password be cached. This is simply because the digest authentication needs to derive a challenge value from a password. That user account/password tupel must in turn be utilized for the innovaphone HTTP client.

We have had reports that digest authentication does not work with some IIS7 servers. Evaluation has shown that these servers do require <code>MD5-sess</code> instead of <code>MD5</code> as endpoint authentication type.

Microsoft states ''For security reasons, Windows-based digest authentication only supports MD5-sess encryption over domain controllers that are running under Windows Server 2003.'' [http://technet.microsoft.com/en-us/library/ms191264.aspx]. This suggests that authenticated HTTP access from an innovaphone box to an IIS7 using a domain account may not work at all as long as we do not support MD5-sess (which we don't do as of this writing (January 2012)). A possible fix may be to use a local server account (although this has not been tested).

===Microsoft Internet Information server (IIS7.5)===
Despite an allegedly configured server role ''WebDAV Publishing'' a WebDAV-connect wasn't possible until adding a ''WebDAV Authoring Rule'' by means of the IIS Admin.
*'''Access for''' Entire Content
*'''Grant Conten Access For''' All Users
*'''Rights''' Read, Source, Write

Before administrating this step a ''PROPFIND'' was always honored by a ''405/Method Not Allowed''.

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

You should '''change the default PIN''' to a different value before installing the Voice Mail. This is done with a text editor in the ''vm.xml'' script. Change the value <code>8765</code> in function ''CheckPin'' and function ''EnterPin''.

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

* $_initdelay: Controls, whether an initial silence prompt is going to be played to a caller. From on script version ['''vm.xml 60096'''].
** 0(default): No silence prompt will be played.
** a value greater than 0: A silence prompt of ''N'' seconds is going to be played. For hosting scenarios the recommended value is '1'.

* $_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,g722,opus-wb,opus-nb

* $_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

* $_noctl (from on v8hotfix8)
**true: Control-calls (calls without media) will be rejected
**false (default): no rejection

* $_divconn (from on v9hotfix17)
**true: Auto-Connect for calls being recognized as diverted or transferred calls
***Note: Until V11r1sr2 the former default was ''true''
**false(default): No automated connection for diverted/transferred calls.
'''Note:''' It is recommended to configure '''$_divconn=false''' in scenarios with remote media streaming(via an active registration at the VM object).

* $_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

*$_leg2tweak (from on v9hotfix21) controls <pbx-getcallinfo out-leg2=".."/>
**true(default): set leg2 to <ext-nr> from <vm-nr>+<ext-nr>
**false: set leg2 according to received divertingInfoLeg2 facility

*$_trailhash (from on v9hotfix21) controls <pbx-getcallinfo out-cdpn=".."/>
**true: pass trailing (en-bloc) '#' into cdpn
**false(default): don't pass trailing (en-bloc) '#' into cdpn

* $_pbxfwdrel controls <pbx-fwd> (from on v10sr5)
**conn: release all interpreter resources after a successful connect. No further scripting affects the call.
**imm: release all interpreter resources immediately on the execution of the <pbx-fwd> statement. No further scripting affects the call.
**false(default): No tweaks apply. The script interpreter remains active.

*$app activates settings, necessary for the App Platform's Voicemail App (v13r1 and later only)
**on: Activate internal settings for the Voicemail App (only use this setting if the voicemail runs on the new App Platform)
**off(default): No tweaks apply.

*$_defaultpin configures a default pin (from on vm.xml, 60137)
**E.g. to configure the default pin ''123456'' <code>http://a.b.c.d/vm.xml?$_defaultpin=123456</code>

==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==
=== Maximum Message Length ===
By default, voicemail messages are limited to 50 seconds each.
To change the maximum length (e.g. to 5 minutes), you have to change the following code line

<pbx-record url="$vm" sec="50"/>

to

<pbx-record url="$vm" sec="300"/>

=== Change Filename of the Recorded Messages of Voicemail ===

By default the vm.xml records the voice messages in the CF at UserBox with an Unique Name, type of GUID + Extension and this is also what is send to the user email when we set that option. Example : 2110d5f4e909d311baab0090332901b6-202.wav

We can change this filename format by editing the vm.xml approx. line 63:

replace

<store-getnew root="$sub" out-url="$vm"/>
<lib-strcat string="$vm" string2="-" out-string="$vm" />
<lib-strcat string="$vm" string2="$cgpn" out-string="$vm" />
<lib-strcat string="$vm" string2=".g711a" out-string="$vm" />

with

<store-getstat root="" name="NULL" out-wday="$wday" out-mday="$mday" out-mon="$mon" out-year="$year" out-hour="$hour" out-min="$min"/>
<store-get root="$sub" name="Date_" out-url="$vm"/>
<lib-strcat string="$vm" string2="$year" out-string="$vm" />
<lib-strcat string="$vm" string2="_" out-string="$vm" />
<lib-strcat string="$vm" string2="$mon" out-string="$vm" />
<lib-strcat string="$vm" string2="_" out-string="$vm" />
<lib-strcat string="$vm" string2="$mday" out-string="$vm" />
<lib-strcat string="$vm" string2="_time_" out-string="$vm" />
<lib-strcat string="$vm" string2="$hour" out-string="$vm" />
<lib-strcat string="$vm" string2="_" out-string="$vm" />
<lib-strcat string="$vm" string2="$min" out-string="$vm" />
<lib-strcat string="$vm" string2="_number-" out-string="$vm" />
<lib-strcat string="$vm" string2="$cgpn" out-string="$vm" />
<lib-strcat string="$vm" string2=".g711a" out-string="$vm" />

Doing this will obtain a filename with Date, Hour, Number and CGPN.

===Leave Message to the VoiceMail Box of the original called User===
By default the VoiceMail stores the voice message to the Mailbox of the Object performing diversion to the VoiceMail. E.g. if "User A" creates a call forward to the VoiceMail, the Mailbox is used to store the message is from "User A". In case "User A" creates a call forward to a Waiting Queue or Call Broadcast, and than from Call Broadcast Group to the VoiceMail, the message will be stored in the Mailbox of the Call Broadcast Group.

To change this behaviour and to store the Message always to the Mailbox of the originally called User, change the vm.xml as following:

search the line:

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

and replace them with the following

<syntaxhighlight lang="xml">
<pbx-getcallinfo out-cgpn="$cgpn" out-cdpn="$cdpn" out-leg2="$leg2" out-leg2-orig="$leg3"/>

<switch var="$leg3">
<case not-equal="">
<assign out="$leg2" value="$leg3"/>
<assign out="$_pbxcdpn" value="$leg3"/>
</case>
</switch>
</syntaxhighlight>

===Sending of additional MWIs===
A comma-separated list of MWI destinations/recipients can be configured by means of a variable $_m within the script URL's query string. [[Howto:Group_Voicemail | The Group Voicemail article]] outlines a configuration scheme for this functionality.

Alternatively, the [[Howto:How To Send Additional MWIs within a PBX|How To Send Additional MWIs within a PBX]] describes an older solution - not integrated within the [[Reference13r2:Concept_App_Service_Voicemail | Voicemail App]].

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

===Enable Mailbox Administration from extern===
Since build 60143 the administration menu was removed.
It is possible to log in into the voicemail administration with a ''9'' as DTMF key while leaving a message. After entering the correct [[Howto:Configure_the_innovaphone_Voicemail#PIN_Administration|PIN]], you can access the voicemail administration.
This may create problems, if you use an unsecure PIN, no PIN or the default PIN.

To bring back this function you have to change the following code line inside the function ''AnsweringMachine'' in your ''vm.xml''.

<syntaxhighlight lang="xml">
<if notcond="$greeting">
<assign out="$greeting" value="box"/>
</if>

<switch var="$greeting">
</syntaxhighlight>

to

<syntaxhighlight lang="xml">
<if notcond="$greeting">
<assign out="$greeting" value="box"/>
</if>

<event type="dtmf" block="false">
<pbx-getdtmfdigit out-dtmf="$dtmf" />
<switch var="$dtmf">
<case equal="9">
<call name="Voicebox"/>
</case>
</switch>
</event>

<switch var="$greeting">
</syntaxhighlight>

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

==Special-Purpose Script Variables, Firmware Version 13r1==
From on 13r1 a few script variables with special meaning were introduced. Among others, this enables a script to read the static configuration underneath ''PBX/Config/Authentication/Email Verification''.
;$_pbx_auth_email_server:
Retrieves ''PBX/Config/Authentication/Email Verification/SMTP server''
;$_pbx_auth_email_host:
Retrieves ''PBX/Config/Authentication/Email Verification/Client host name''
;$_pbx_auth_email_addr:
Retrieves ''PBX/Config/Authentication/Email Verification/Email address''
;$_pbx_auth_email_usr:
Retrieves ''PBX/Config/Authentication/Email Verification/Username''
;$_pbx_auth_email_pwd:
Retrieves ''PBX/Config/Authentication/Email Verification/Password''
;$_pbx_auth_email_sender:
Retrieves ''PBX/Config/Authentication/Email Verification/Sender name''
;$_pbx_version_soap:
Retrieves the firmware version. E.g. "1300" for 13r1.

==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 the voicebox is created upon the first call to the users voicemail, you must not have the ''Send Number'' property configured in the calling user object. Otherwise, the voicebox will be created for the wrong number
* [[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"]]
*[[Support:Webdav_Access_Slow_From_Windows_7_/_Vista|Support:Webdav Access Slow From Windows 7 /Vista]]
* You can not have a voice mailbox for users that have a slash (<code>/</code>) in the ''Long Name''. For such user, when calling the voice mail, a spoken error message ''an error occured'' is heard
** de: ''es ist leider ein Fehler aufgetreten''
* If the voicemail URL is a webdav server on a LinuxAP, the dns domain name of the URL must be typed in lower cases, otherwise changes to the welcome and personal message (name_greetings and personal_greetings) won't be correctly saved.
* If the voicemail is located on a webdav server on a LinuxAP make sure the folder of the voicemail has for group and owner "www-data" and not "root". Otherwise you cannot create user folders.
* Forking to a VM Object without mobility object (license required) will display the name of the forking target in the caller display and his calllist. (To prevent this behaviour, use a mobility object for the forking to <code>doorcall-trigger</code>)

Innovaphone MyApps Cloud
* If you are setting up a Myapps Cloud Instance and you want to change the default PIN of the Voicemail Object via URL Query String Variable the Instance will get Stuck in a boot loop. You then have to contact the cloud team to reset your instance to the last backup.

== 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]]
* [[Howto:Forward your Mobile's Mailbox to your innovaphone Voicemail]]
* [[Howto:MWI for DECT]]

===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]]
*[[Howto:Send Email from the innovaphone Voicemail without saving data on the CF]]
*[[Howto:Localize Voice Mail Messages]]

===Voicemail Scripting===
*[[Howto:Wiki_Sources]]
*[[Howto:Implement a simple caller notification]]
*[[Howto:Getting started with your own PBX voicemail script]]
*[[Howto:Debug_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]]
*[[Howto:Control Call Forward with Voicemail XML Script]]
*[[Howto:Using the Voicemail object as a post call review]]
*[[Howto:Voice_Mail_multiple_announcements_with_and_without_possibility_to_leave_a_message]]
*[[Howto:Speaking_Clock_with_Voicemail_XML_Script]]
*[[Howto:Absence_Memo_with_VoiceMail_XML_Script]]

== Download ==
The voicemail product can currently be found on the [http://download.innovaphone.com/ice/6.00/#apps apps section] of the innovaphone download site. This product is suitable for PBX firmware ''versions 6 and up''.

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