~~Title: Server Edition SIP ~~ ====== IP Office 9 SIP Server Edition ====== For **DuVoice 6.0** SIP please follow [[integration:avaya:ipoffice:ipofficesipwv6|IP Office 10.x]] integration notes. This document covers IP Office version 9.X Server Edition when using SIP. All configuration is performed from the Avaya IP Office Manager application. This application can be installed on the DuVoice system without interfering with the DuVoice operation and is suggested for easy configuration checks by DuVoice technical support. When using multiple IP500's within an IP Office Server Edition Solution, you must create a new location on the DuVoice system for each of these servers. Then configure all the guest mailboxes located on a specific IP500 within it's own location. This is necessary when configuring IP Office User Configuration under connectors so that the name and class of service changes are made to the appropriate IP Office. The Avaya User Configuration API does not currently support changing names and class of service across a solution. {{section>dv520:pbx:avaya:ipofficev9:ip500#features}} ===== Requirements ===== * 3rd Party IP Endpoints. For every line on the DuVoice requires a SIP endpoint license. The 3rd Party IP Endpoints license is sold in packs. It is possible to have more than a single 3rd Party Endpoint license in order to reach the number of lines supported. * CTI Pro if using: * Emergency Alert Notification. (required on every IP Office system that will be monitored) * Performing message waiting using TAPI. * Station monitor for offhook stations. * Lan connection. * Voice Compression Module. Example: VCM64/ATM4. * IP Office manager software. ====== PBX Configuration ====== When configuring an IP Office Server solution you must manage users, extensions and groups discussed here on the server and not under Solution. If you have additional IP500's connected to the solution it is suggested to manage them via that specific Server rather than under Solution as well. {{:images:pbx:avaya:ipoffice9:se-iposrvrmain.png?direct|}} {{section>dv520:pbx:avaya:ipofficev9:ip500#Security Configuration}} ==== System ==== SIP Registrar settings can be configured for either LAN1 connection, typically only LAN1 is used however. When configuring the DuVoice you will use the IP address of the LAN port you enabled the registrar for. === Enable SIP Registrar === {{:images:pbx:avaya:ipoffice9:ipoffice-system-voip.png?direct|}} * **SIP Registrar Enable** \\ This field should be //checked//. === SIP Registrar === {{:images:pbx:avaya:ipoffice9:ipoffice-system-registrar.png?direct|}} * **Auto-create Extn/User** \\ This field should be //unchecked// for most installations. === Voicemail === IP Office server edition does not support 3rd party voicemail and therefore nothing is to be configured on this tab in relation to DuVoice. ==== Voicemail PBX Configuration ==== This section describes how to configure the IP Office for the DuVoice VMS. === Extension === Each line on the DuVoice will require it's own extension each configured using the following steps. == Extension Extn tab == {{:images:pbx:avaya:ipoffice9:ipoffice-extension-extn.png?direct|}} * **Force Authorization** \\ DuVoice suggests not to use authentication so this field should be //unchecked//. == Extension VOIP tab == {{:images:pbx:avaya:ipoffice9:ipoffice-extension-voip.png?direct|}} * **Codec Selection** \\ Set to //Custom// and remove all but //G.711 ULAW 64K// and //G.711 ALAW 64K// from the **Selected** column. * **Selected** \\ Reorder the codecs so //G.711 ULAW 64K// is first. * **DTMF Support** \\ Set to //RFC2833//. If during testing you find the system not responsive enough to DTMF you may try //Inband//. === Users === Create a user for each of the SIP extensions created for the DuVoice system. {{:images:pbx:avaya:ipoffice9:ipoffice-user-main.png?direct|}} == Voicemail == {{:images:pbx:avaya:ipoffice9:ipoffice-user-voicemail.png?direct|}} * **Voicemail On** \\ uncheck this setting. == Telephony == {{:images:pbx:avaya:ipoffice9:ipoffice-user-telephony.png?direct|}} * **Call Waiting On** \\ This must be //checked// in order to support transfers. == Button Programming == {{:images:pbx:avaya:ipoffice9:ipoffice-user-buttons.png?direct|}} * Remove all line appearances except one. === HuntGroup === Create a huntgroup which contains all extensions you created for the DuVoice system in it's User List. {{:images:pbx:avaya:ipoffice9:ipoffice-huntgroup-main.png?direct|}} * **Queuing Tab** \\ Queuing should be disabled. * **Overflow Tab** \\ Configure as needed based on your site requirements. For most installations it is suggested to overflow to the operator huntgroup. * **Voicemail Tab** \\ Voicemail On should be //unchecked//. * **Voice Recording Tab** \\ **Record Inbound** should be //None//. \\ **Mailbox** should be empty. * **Announcements Tab** \\ **Announcements On** should be //unchecked//. ==== Guest Room Configuration ==== **Note:** Guest rooms cannot be hidden from the directory or TAPI MWI and DND will not work. === Extensions === If the guest is using analog extensions it is recommended to use the following settings. {{:images:pbx:avaya:ipoffice9:userext.png|}} * **Equipment Classification** \\ Select **Standard Port**. * **Message Waiting Indication Type** \\ Select **On**. Depending on the telephones MWI type you may need to change this another option. === Users === == Voicemail == {{:images:pbx:avaya:ipoffice9:ipofficeuservm.png?direct|}} * **Voicemail On** \\ This must be unchecked for all guest mailboxes. == Forwarding == You must configure all guest rooms on the remote IP Office to use forwarding {{:images:pbx:avaya:ipoffice9:ipoffice-forward-sc.png?direct|}} * **Forward On Busy** \\ Check this option. * **Forward On No Answer** \\ Check this option. * **Forward Number** \\ Enter the huntgroup. If this guest is located on a remote IP Office via Small Community Networking, enter the shortcode created for SCN forwarding above instead. * **Forward Internal calls** \\ uncheck this option unless you are not using DuVoice as the primary Voicemail. This allows the system to use the default //Voicemail// setttings for any stations calling from either the main or remote IP Office. === User Right Groups === Create User Right Groups for guest room phones. Although there are many options, the typical configuration is a user rights group for the phones while the room is checked in and another user rights group for the phones while the room is checked out. DuVoice must contain the exact name of the user rights group, case sensitive. Example: "CheckIn" and "CheckOut". ==== Multiple IP Office Forwarding ==== If you have multiple IP Offices at a single site follow these steps for creating a shortcode for forwarding remote guests to the DuVoice. A shortcode is used to forward users from another IP Office when the DuVoice extensions are not on the same pbx. This is because the IP Office does not provide called party information to forwarded extensions. This will only work when using SIP or TAPI integration. {{:images:pbx:avaya:ipoffice9:forward2vmshortcode.png?direct|}} * **Code** \\ *67; * **Feature** \\ Dial Extn or //Dial Physical Extn by Number// if //Dial Extn// is not available. * **Line Group ID** \\ Enter the line groop id for the PBX which the DuVoice is connected. * **Telephone Number** \\ DuVoice huntgroup number, followed by //|>>E// ===== Shortcode Configuration ===== ==== MWI ShortCodes ==== The DuVoice system can use multiple methods to light the message waiting indicator. The perferred method is to use shortcodes which are dialed by the DuVoice system. The other method is to use TAPI which does not require any configuration on the PBX. These shortcodes should be entered in order to support MWI enable/disable. Once entered and saved to the IP Office it is suggested to test these codes using any telephone connected to the PBX. Using this code you should be able to set or clear any phone's MWI light on the PBX even the one your dialing from. //**Note: These codes will not work on any SIP phone.**// Avaya IP Office does not support message waiting lights on any SIP phones. However the DuVoice can still light the lights on these phones using either it's SIPX method which is explained in the DuVoice Manual. === ShortCode for MWI ON === {{:images:pbx:avaya:ipoffice9:mwioncode.png?direct|}} * **Telephone Number** \\ N";Mailbox Msgs=1 OLD=0 Sav=0" === ShortCode for MWI OFF === {{:images:pbx:avaya:ipoffice9:mwioffcode.png?direct|}} * **Telephone Number** \\ N";Mailbox Msgs=0 OLD=0 Sav=0" === DuVoice Configuration === If for any reason you wish to convert from using TAPI for MWI set all MWI Notification templates method to **Inband**. Then using System Configuration edit the active Integration template and set the MWI On and off codes to the following. == MWI On commands == {{:images:pbx:avaya:ipoffice9:shortcodemwion.png?direct|}} == MWI Off commands == {{:images:pbx:avaya:ipoffice9:shortcodemwioff.png?direct|}} ==== Operator Shortcode ==== By default the DuVoice assigns the operator mailbox extension "0". This will be dialed for transfers to the operator, Failed wakeup alerts, and possible 911 Emergency alerts. Avaya IP Office does not have a 0 extension by default. It is required to configure a shortcode that will direct calls to 0 to the appropriate extension or huntgroup. This will normally be the reception desk. The following example sends 0 to huntgroup 501. {{:images:pbx:avaya:ipoffice9:operatorshortcode.png?direct|}} ===== TAPI Installation ===== This section may be skipped unless you are using one of the following: * Performing message waiting using TAPI. * Station monitor for offhook stations. If you purchased your system from DuVoice, the TAPI installation may be found under //C:\OEM\Avaya//. If this is a kit or you cannot find the version for your specific PBX the driver can be found on the User CD available from Avaya. ==== Installation ==== {{:images:pbx:avaya:ipoffice9:tapi01.png?direct|}} * Click **Next**. {{:images:pbx:avaya:ipoffice9:tapi02.png?direct|}} * Click **Cancel**. Choosing the PBX at this stage has caused installation issues forcing the TAPI driver to remain in Single User mode which cannot be used. {{:images:pbx:avaya:ipoffice9:tapi03.png?direct|}} * Click **Install** {{:images:pbx:avaya:ipoffice9:tapi04.png?direct|}} * Click **Yes**. {{:images:pbx:avaya:ipoffice9:tapi05.png?direct|}} * Click **Next**. {{:images:pbx:avaya:ipoffice9:tapi06.png?direct|}} * Click **Finish**. ==== Configuration ==== Configuration is performed from the Windows Control Panel app **Phone and Modem**. {{:images:pbx:avaya:ipoffice9:tapi06.png?direct|}} * Hightlight **Avaya IP Office TAPI2 Service Provider**. * Click **Configure**. {{:images:pbx:avaya:ipoffice9:tapi06.png?direct|}} * **Switch IP Address** \\ Enter the IP address of your IP Office. * **Third Party** \\ Check this radio button. * **Switch Password** \\ Enter the password for your PBX, typically //password//. * Click **Ok**. ===== DuVoice Configuration ===== If your system was purchased from DuVoice you can skip the Installation of Dialogic and the DuVoice software and go directly to Setup Wizard. For Kit installations you must install Dialogic HMP followed by the DuVoice software. ==== Using SIP ==== {{:images:520:setup:welcome.png?|}} * Click **Next**. {{:images:520:setup:siteinfo.png?|}} * Fill in all the fields with the site information. * Click **Next**. {{:images:520:setup:ipoffice-1.png|}} * Select the option which best matches your PBX or Other if your PBX is not listed. * Click **Next**. {{:images:520:setup:ipoffice-2.png?|}} * Unless you have chosen Other as your PBX you will be presented with the choice to configure the default setting for message waiting indicators. Some PBX's support multiple types, choose the one which you want to use for your PBX in this case. If you have elected to use ShortCodes choose "Inband using shortcodes". * Click **Next**. {{:images:520:setup:sippbx.png?|}} * Enter the IP address of your PBX for SIP registration. * Click **Next**. {{:images:520:setup:lines.png?|}} * Enter the huntgroup of the DuVoice system you have created in the PBX. * If all the stations are numerical check **Auto increment extension numbers based on line 1.** and enter the first line number in the space provided. If they are not enter the extension number for each port. * Click **Next**. {{:images:520:setup:ipoffice-3.png?|}} * Click **Finish** if all the setting are correct. ==== Push Server ==== If your running InnDesk along with push server, you can configure it to serve the phone bin and configuration files needed by your IP phones and the DuVoice push server. === Requirements === * InnDesk vesion 1.70 or above. * DuVoice push server configured. * DuVoice EAS feature license. * IP Office. === Configuration === When a IP phone is booted it will attempt to load it's configuration settings file from the HTTP server configured. The InnDesk install places special configuration files in it's folder to force each type of phone to read the same configuration file. For advanced configuration you may edit each of these files to make them suit your particular needs but this is not covered here. == 46xxsettings == This file is used for all models of phones and by default all groups and is located in **c:\dvweb\static**. - Using notepad open the file **C:\dvweb\static\46xxsettings.txt**. - Change all IP addresses in the file to point to that of the DuVoice system. This will be the same IP address used to configure all the phones HTTP server. **Note:** Do not edit any other file in **C:\dvweb\static**. For custom overrides edit the files in **C:\dvweb\avaya**. == Example File == ################################################ ## ## DuVoice Custom 46xxsettings.txt file. ## ## This file contains all the minimum requirements ## for avaya ip phones. ## ## Lines which start with two ## are comments ## ## Lines which start with a single # are labels for goto statements ## ################################################ ## ## INSTALLER ## ################################################ ## ## Change only the IP addresses in this file to match the IP address ## which push server is configured to use. This is configured in ## System Configuration | Features | Push Server ## ## Then either configure each phones HTTP server to this IP address ## or within the the IP Office Manager. ## ## You may place all IP Office BIN files and other configuration files ## into the folder C:\DVWEB\AVAYA and the phones will pull any updates they ## need from there. There is no need for additional TFTP or HTTP servers. ## ################################################ ################################################ ## ## ADVANCED SETTINGS ## ################################################ ## Using groups allows a site to block some phones from supporting ## PUSH server. Examples might include excluding IP phones in ## guest rooms from PUSH access or to use different settings than ## staff phones. ## ## To change the group number from the phone: ## 4 7 6 8 7 # ## groupnumber # ## ## To reset EVERYTHING on the phone. This will delete all settings ## do not use this unless you really wish to reset the phone. ## 7 3 7 3 8 # * # ## ################################################ ## Example of special group settings # IF $GROUP SEQ 100 goto GUEST-PHONES ## End of custom checks. goto ALL-PHONES ################################################ ## This block is an example of using groups for ## specific types of phones. ################################################ # GUEST-PHONES ## SET TPSLIST 192.168.1.1:8090/ ## SET SUBSCRIBELIST http://192.168.1.1:8090/ ## SET WMLHOME http://192.168.1.1:8090/ipphone/idle.wml goto END ################################################ ## All phone types use the same settings. ################################################ # ALL-PHONES SET TPSLIST 192.168.1.1:8090/ SET SUBSCRIBELIST http://192.168.1.1:8090/ SET WMLHOME http://192.168.1.1:8090/ipphone/idle.wml ## SET WMLIDLEURI http://192.168.1.1:8090/ipphone/idle.wml ## Optional settings ## SET WMLIDLETIME 20 ## SET SCREENSAVERON 25 goto END ## END OF FILE. # END == IP Phones == Each IP phone should have it's HTTP Server set to the DuVoice IP address. HTTPS Server setting should be left blank as this is not supported. == BIN Files == Place all your bin files and custom configuration files in **C:\dvweb\avaya** with the exception of the 46xxsettings.txt file. ===== Advanced Configurations ===== Listed here are some of the most common advanced configurations DuVoice has seen. ==== Multiple Room Extensions ==== In cases where a room may contain multiple phones, each with their own extension these steps are suggested. This setup will support both message waiting and name change for each extension. Each room in the Property Management System (PMS) is configured as hunt group in the IP Office. This should match the primary extension for the room. This hunt group number should also equal the rooms mailbox number. === PBX Configuration === Create a hunt group which contains each extension in the room. {{ :520:admin:multiext01.png|}} * **Name** \\ Enter a name. This field will be modified on name changes. * **Extension** \\ Enter the extension for the room. * **Ring Mode** \\ Set to Collective so all extensions ring. * **No Answer Time** \\ Set this to a reasonable no answer time. Suggested to be 6 seconds. * **User List** \\ Enter all the extensions in the room. {{ :520:admin:multiext03.png|}} * Disable Queuing. {{ :520:admin:multiext02.png|}} * **Overflow Group List** \\ Enter the voicemail hunt group. {{ :520:admin:multiext04.png|}} * **Voicemail On** \\ Uncheck this. === DuVoice Configuration === The system by default has has a template for Message Waiting On/Off, in order to light the Message Waiting indicators for all the rooms extension you will need to create new templates for the maximum number of extensions in any room. In this example each room has two extensions. From **Mailbox Administration** choose Templates | Notifications. {{ :520:admin:multiext05.png|}} * Highlight MWI On, click Copy and enter a meaning full name. {{ :520:admin:multiext06.png|}} * Change the Address number to use. Default is 0, here we enter 1 for the next. Perform this same copy for MWI Off and set the Address number the same. Repeat these steps for every additional extension in the room increasing the Address number each time. From the room, in this example 7114, choose Address List. Edit MWI 0, and enter the first extension number. Add Additional addresses for each extension. {{ :520:admin:multiext07.png|}} Choose Notifications, add the new templates you created to the list. This list may only contain 10 events, if you need to add more choose **Map to DTMF** and add them there. {{ :520:admin:multiext08.png|}} ==== Record-A-Call ==== Using this shortcode you can record a call by conferencing in the DuVoice by dialing this shortcode. The message will be automatically deposited in the mailbox matching the extension which dialed the shortcode. You can replace the //E// with an a mailbox of your choice as well. This will only work when using SIP or TAPI integration. {{:images:pbx:avaya:ipoffice9:recordcallshortcode.png?direct|}} * **Code** \\ *68; * **Feature** \\ Dial Extn * **Telephone Number** \\ DuVoice huntgroup number, followed by S**E ===== Troubleshooting ===== ==== Name Changes ==== Failure for the system to perform name changes can be linked to several problems. These are the most typical reasons why name changes will fail. * Certificate is out of date. * Certificate has been generated by Avaya tech support and not Avaya.com or the PBX itself. * The IP Office has been upgraded. * DuVoice has been upgraded. DuVoice ships the most recent versions of the Avaya Configuration Management API and if the PBX remains at an older version most likely the new Avaya DLL's are not compatible with your PBX. This can only be resolved by upgrading the PBX or by contacting DuVoice tech support. Another cause of failure is because names contain unicode or accented characters which the Avaya does not like. **Note:** \\ The Avaya SDK used to perform these changes is not always compatible with older versions of IP Office. If you feel this might be the case you can try to copy the older DLL's from the older version of IP Office Manager. The voicemail must be shutdown to perform this action. Copy the following DLL's from your IP Office Manager folder (//C:\Program Files (x86)\Avaya\IP Office\Manager//) to the DuVoice folder (//C:\duvoice//). It is strongly suggested you make a backup of the existing versions in case this does not resolve the issue. * AvailabiltyValidationVisability.dll * CoreServices.dll * LegacySettings.dll * SecurityManager.dll * UpgdWiz.dll * WhoIs2.dll * WindowsControlLibrary.dll ==== DND Disables forwarding ==== This is a problem with the Avaya TAPI driver which is used to enable/disable DND for a user. This is typically not a problem, however when using forwarding on users rather than configuring the DuVoice system as the voicemail it can occur. Using System Configuration, goto Features | Connectors | IP Office and check **Disable support for DND**. DND for room phones will no longer work, but can be substituted by configuring additional User Rights groups. ==== Message Button Fails ==== On upgrades and by default the IP Office is configured so that the message button sends user to visual voicemail rather than the voicemail system defined. **Note:** The message button cannot be used on Server Edition because it does not support voicemail of type group. If using a non-server edition the steps below can be used to resolve it. - Login to IP Office Administration. - Go to the System settings. - Click on Voicemail tab - Uncheck “Messages Button Goes to Visual Voice”. You may need to set the voicemail type to something besides “Group Voicemail” if it’s disabled long enough to uncheck the box. - Save changes and merge the configuration. ==== Date and times in logs ==== The IP office monitor application is really nice, however it has one major flaw in that it will not time/date stamp the entries. You can change this behavior by checking the following two fields on the System tab. **Prefix YYYY-MM-DD hh:mm:ss:mss**\\ **Date/Time Periodic Prints** ==== MWI Light goes on then immediately goes off ==== This is typically caused because the extension is configured for voicemail and the DuVoice is not the primary voicemail. Typically the IP Office is configured to use it's own voicemail and when the DuVoice sends a code to turn the light on it will do it, but then immediately turn it off because the IP Office's internal message queue for the extension says it has no messages. The fix in this case is to disable voicemail for the extension. If this is done you must confirm that the extension is using forwarding in order for the DuVoice to act as it's voicemail mailbox. If the extension is to use the IP Office for it's voicemail you must delete the mailbox which corresponds with this extension in the DuVoice or disable voicemail in mailbox's class of service. {{:images:pbx:avaya:ipoffice9:ipoffice-monitor-system.png|}} ==== Calling system gives Fast Busy ==== Typically this is due to the fact the system does not have Voice Compression Module. ==== Wakeup calls forward to VM ==== The recommended no answer time is 25 seconds. {{tag>ipoffice}}