Avaya Solution & Interoperability Test Lab Application Notes for Configuring Citel s Portico TVA with Avaya IP Office Issue 1.0 Abstract These Application Notes describe the configuration steps required for Citel s Portico TVA TM to interoperate with Avaya IP Office 500, Release 6.0. Portico TVA TM SIP Handset Gateway is a network appliance that allows for digital telephones to register with IP Office as SIP endpoints. Emphasis of testing was placed on verifying the gateway s ability to interoperate with Avaya IP Office and with Avaya 2400 Series digital telephones, while delivering SIP functionality to Avaya (formerly known as Nortel) Meridian and NorStar telephones, and Siemens OptiPoint telephones. Information in these Application Notes has been obtained through DevConnect compliance testing and additional technical discussions. Testing was conducted via the DevConnect Program at the Avaya Solution and Interoperability Test Lab. 1 of 38
1. Introduction These Application Notes describe the configuration steps required for Citel s Portico TVA TM to interoperate with Avaya IP Office. IP Office has the capability to extend advanced telephony features to SIP stations. This feature set can be extended to non-avaya SIP telephones. Portico TVA TM SIP Handset Gateway is a network appliance that allows directly connected digital telephones to register with IP Office through standard SIP messaging, emulating a SIP endpoint. From IP Office s point of view, each digital telephone is a SIP telephone. Emphasis of testing was placed on verifying the gateway s ability to interoperate with IP Office and with Avaya 2420 Series digital telephones, while delivering basic telephony as well as features assigned on IP Office and through the usage of hard buttons on the digital sets including Meridian telephones, NorStar telephones, and Siemens OptiPoint telephones. Advanced SIP features were not tested. 1.1. Interoperability Compliance Testing The compliance testing focused on the following areas: 1. Installation & Configuration 2. Portico TVA TM /Avaya Feature Functionality Verification 3. Failover and Serviceability Tests The installation and configuration testing focused on the setup of all components and the ability to interoperate. The functionality testing focused on verifying the ability of Portico TVA TM to detect, register, and provide basic telephony as well as features assigned on IP Office and through the usage of hard buttons on the digital sets in a telephony environment for multiple digital set types. The serviceability testing focused on verifying the ability of Portico TVA TM to recover from adverse conditions including loss of power and loss of network connectivity. 1.2. Support Technical support contact information for Citel s Portico TVA TM can be obtained through the following: Web: http://www.citel.com/company/contact.asp Telephone: 1-888-454-5828 (7/24 without ticket); 1-206-957-6270 (7/24 with ticket) Email: support@citel.com 2 of 38
2. Reference Configuration The interoperability of digital telephones, Citel s Portico TVA TM, and Avaya IP Office 500 Release 6 is accomplished through digital to SIP conversion through the gateway. The compliance test configuration used to test Portico TVA TM includes the IP Office R6V8, patch panel, Portico TVA TM Release 4.00.0, and Avaya IP Office 2420 Series digital telephones. Only digital telephones were used to certify this configuration. IP telephones were not tested. Figure 1 provides a high level topology. Figure 1: Portico TVA TM Compliance Test Sample Configuration 3. Equipment and Software Validated The following equipment and software were used for the sample configuration provided: Equipment Avaya IP Office 500 R6.0, V8 Software/Firmware Avaya 2420 Series Digital Telephones Firmware Version 6 Meridian M3903 & M3904 Series Digital Telephones NorStar T7316E Series Digital Telephones N/A N/A Siemens OptiPoint 500 Basic, OptiPoint 500 Advance, OptiPoint 500 Standard N/A Portico TVA TM Gateway 4.00.0 3 of 38
4. Configure Avaya IP Office All the configuration changes in this section for Avaya IP Office are performed through the Avaya IP Office Manager. For more information on configuring Avaya IP Office, refer to the Avaya product documentation, Section 9, Reference [1]. This section provides the procedures for configuring Avaya IP Office. The procedures fall into the following areas: Verify Avaya IP Office Licensing Setting LAN Parameters Setting Route and Gateway Administer Avaya IP Office SIP Extensions & Users Administer Avaya IP Office Digital Extensions 4.1. Verify Avaya IP Office Licensing From a PC running the Avaya IP Office Manager application, select Start -> Programs -> IP Office -> Manager to launch the Manager application. Select the proper IP Office system, and log in with the appropriate credentials. The Avaya IP Office R6 Manager screen is displayed. From the configuration tree in the left pane, select License -> 3 rd party IP Endpoints to display the 3 rd Party IP Endpoints screen in the right pane. Verify that the License Status is Valid. 4 of 38
4.2. Set LAN Parameters In the Avaya IP Office Manager application, LAN parameters including IP Address, IP Mask, and other profile settings are set. From the configuration tree in the left pane, select System. In the right pane, select LANX -> LAN Settings to display the LAN Settings screen in the right pane, where X is either 1 or 2. Typically, LAN1 is used. If more than one configuration is needed, alternatively LAN2 can be used. For the compliance testing, LAN2 was used, as shown below. Set the IP Address, which is the address of the IP Office. Set the IP Mask based on the network setup. Set the DHCP Mode based on your IP Office configuration needs. In this case, Disabled was chosen since DHCP was not used. Other fields can be left blank or at the default settings. Select OK, then Save the changes. 5 of 38
From the configuration tree in the left pane, select System. In the right pane, select LANX -> VoIP to display the VoIP tab screen in the right pane. Activate SIP Registrar Enable by checking the box. For the compliance testing, this was the only field changed. The other settings were left at the system settings. Select OK, then Save the changes. 6 of 38
In the Avaya IP Office Manager application, LAN parameters including SIP Registrar settings are set. From the configuration tree in the left pane, select System. In the right pane, select LANX -> SIP Registrar to display the SIP Registrar screen in the right pane. The Domain Name is left blank. Set the Layer 4 Protocol to Both TCP & UDP. Set the TCP Port to 5060. Set the UDP Port to 5060. Other fields can be left blank or at the default settings. Select OK, then Save the changes. 7 of 38
4.3. Setting Route & Gateway In the Avaya IP Office Manager application, Routing parameters are set. From the configuration tree in the left pane, select IP Route. Right click on the IP Route pane and click New. The IP Address set to 0.0.0.0 sends all of the traffic through that path. The IP Mask should match that in Section 4.2. The Gateway IP Address is the IP Address of the router/gateway. The Destination is LANX, either LAN1 or LAN2, as specified in Section 4.2. Other fields can be left blank or at the default settings. Select OK, then Save the changes. The screen below shows the new IP Route once it has been added and saved. 8 of 38
4.4. Administer Avaya IP Office SIP Extensions & Users From the configuration tree in the left pane, select the Extensions tab. Right click on Extensions and click New to add a new Extension. The arrow pointing to the right gives three choices of Extension type. Choose SIP Extension. The following procedures are applicable regardless of digital telephone type since IP Office recognizes the telephones as SIP endpoints coming from the gateway. The Extension ID is automatically generated as the next sequential number in the IP Office. The Base Extension is the number to be dialed to reach the telephone, in this case 400. The other settings were left at the default values. Select OK, then Save the changes. 9 of 38
From the configuration tree in the left pane, select the User tab. Right click on the User pane and click New to add a new user. The following procedures are applicable regardless of digital telephone type since IP Office recognizes the telephones as SIP endpoints coming from the gateway. Enter a descriptive Name and Extension. The Name has to start with characters. Portico TVA TM does not accept spaces. The Password and Confirm Password should be a matching value. The Extension can be digits only; 400 in the example below. Other fields can be left blank or at the default settings. Select OK, then Save the changes. The screen below shows the new User once it has been added and saved. 10 of 38
Other programming can be done in the User fields, including features, button programming, codecs, and displays. From the tabs in the right pane, select the Telephony tab. Under the Call Settings tab, click the box for Call Waiting On. Other fields can be left blank or at the default settings. Select OK, then Save the changes. 11 of 38
From the tabs in the right pane, select the Telephony tab. Under the Supervisor Settings tab, click in the box for Login Code and enter a password for the SIP phone. Other fields can be left blank or at the default settings. Select OK, then Save the changes. 12 of 38
From the tabs in the right pane, select the Button Programming tab. For the compliance test, three call Appearances were administered as well as Hold and Conference. Other fields can be left blank. Select OK, then Save the changes. 13 of 38
From the tabs in the right pane, select the SIP tab. For SIP Name, put in the Extension administered previously. For SIP Display Name (Alias), put in the User administered previously. For Contact, put in the Extension administered previously. Select OK, then Save the changes. 14 of 38
From the configuration tree in the left pane, select the Extension tab. Choose the Extension to be configured, in this case 400. Select the VoIP tab in the right pane. If conferencing will be used, uncheck Allow Direct Media Path and Re-invite Supported. Other fields can be left blank or at the default settings. This is the tab where the Compression Mode can be changed from the G.711 default. Select OK, then Save the changes. 15 of 38
4.5. Administer Avaya IP Office Digital Extensions The predefined digital users and extensions were used for compliance testing. Plug in a digital telephone, in this case an Avaya 2420 Series telephone. Telephone is assigned a User and Extension based on the port into which it is plugged. Do this for each digital set needed for testing or use. Select OK, then Save the changes. 16 of 38
17 of 38
5. Configure Portico TVA TM This section provides the procedures for configuring Portico TVA TM. The procedures include the following areas: Initial Serial Configuration Web Portal Configuration For more information on configuring Portico TVA TM, refer to the Citel product documentation, Section 9, References [2], [3], and [4]. 5.1. Serial Configuration of Portico TVA TM When first configuring Portico TVA TM, access can be gained using a direct serial connection. This can be done using PuTTY. Open a PuTTY window, choose the radio button for a Serial connection. It defaults to COM1 and 9600 Speed. Click Open, and the window below for the gateway appears. 18 of 38
After hitting any key, the screen below allows the user to choose Configuration, Status, Utilities, or Logout. Choose Utilities and hit enter. This will take you to the Setup Wizard prompt. Using the down arrow key, choose Setup Wizard and hit enter. 19 of 38
The Setup Wizard window is displayed, as seen below. Each question for configuration asks for a yes y or no n response and then enter. From this wizard, the name and region can be configured, in this case Portico TVA and United States. 20 of 38
The next configuration step is to set the PBX type. The choices are listed below, including Meridian, Norstar, NEC, Definity, Toshiba, Panasonic DBS, Ericsson, and Siemens. This is set according to the telephone type. It is critical that the right PBX type is chosen so that the administrator can choose the correct digital telephone types on the web interface, as shown in Section 5.2.3. 21 of 38
After the PBX type is chosen, the IP configuration is administered based either on static or dynamic addressing. In this case, static addressing was used. Once these values are entered, a short summary screen shows the changes. Enter y to accept the configuration. Once this configuration is accepted, the unit will prompt for a required reboot. After reboot, the system is ready for use and accessible from the web. 22 of 38
5.2. Web Portal Administration for Portico TVA TM Access the Portico TVA TM web-based interface using the URL http://ip-address in an Internet browser window, where ip-address is the IP Address of the Portico TVA TM Gateway. The Login screen is displayed as shown below. Log in using the appropriate credentials. This section provides the procedures for configuring Portico TVA TM parameters from the web. The procedures include the following areas: Port Administration Line Administration Dialing Rules Telephone Status 23 of 38
Once logged in, the Administrator Portal screen below appears. Additional system changes can be made under the System Information tab. Dialing Rules must be administered based on the users/extensions administered in Section 4.4 and Section 4.5. Ports and Lines are administered under the Configure Handsets tab. The Ports are the physical ports on the patch panel that the telephones are plugged into and the Lines are the path calls will traverse. Access to the PSTN can be administered under the PSTN Access tab. This was not used for this compliance test. Network parameters can be changed under the Network tab. Defaults were used for this compliance test. 24 of 38
5.2.1. Port Administration The TVA lines and ports are configured so that the digital endpoints can register with the IP Office. To configure the ports, click the Configure Handsets option on the Administrator Portal as shown in Section 5.2. The Configure Handsets page is shown below. The Port Name values are assigned sequentially, starting with Port 1. The administrator can optionally assign a different name to identify this port and the telephone attached to it. For compliance testing, these were left at the default sequential values. The User Name is blank by default. For compliance testing, names were assigned. These values can be used for GUI login. The Type Configured is a drop-down list containing the supported phone types for the PBX Type selected in the Setup Wizard in Section 5.1. Port Status and SIP Status give real-time status of the port availability and registration. Configuration links to the Handset Configuration page and the Line Configuration page. 25 of 38
Portico TVA TM has a telephone type auto-discovery capability. For PBX types that support auto-detection, when a phone is plugged into a port, Portico TVA TM detects the phone type and displays it in the Type Detected column. If the Type Detected differs from the Type Configured then a button is displayed. Click the button to update the type configured to that detected. Click Submit (not shown). The configuration is updated and the phone is reset automatically. If the Auto-Detect mechanism is unable to find a handset, use the Configuration Type dropdown as shown below. Check the Reset box and click Submit (not shown). 26 of 38
5.2.2. Line Administration A line must be entered for each port. To configure the lines for an individual port, click the Lines hyperlink on the Configure Handsets page for a particular port. 27 of 38
In this case, Port 1 was chosen. The screen that appears allows for the addition of two lines. The default is (Empty). Click Edit Line X to get to the Port X Line X Configuration Page. 28 of 38
On the Port X Line X Configuration screen, populate the following fields: The SIP Address-of-Record (AOR) is the Extension @ the IP Address of the IP Office. The Display-Name is a descriptive name of the Extension. The Registration Domain and Proxy Server Address are the IP Address of the IP Office, set in Section 4.2. The Update Authorisation is checked by default and can remain at that value. The Username is the same as the User created in IP Office Manager in Section 4.4. The realm is ipoffice. The Password is the login code for that Extension, set in Section 4.4. Click Submit to enter changes. 29 of 38
The handset type has already been configured on the Configure Handsets page. Additional handset details are set on the Handset Configuration page including Port Enabled, Port Name, End-User GUI access details, Default Display (information displayed on the display screen when the phone is idle), Features, and Key Mappings. To access the Handset Configuration page for a specific port, click the Handset hyperlink on the main Configure Handsets page. For the compliance test, the remaining values were left at default, including the check boxes for Port Enabled and End-User GUI Enabled. Click Submit to enter changes (not shown here). 30 of 38
Populate the end user GUI information from the Port X Handset Configuration page by clicking Change. The Username matches the name populated in IP Office in Section 4.4. The New Password and the Retype Password will be used by the End-user to log into the Administrator Portal, as shown on the Login page in Section 5.2. These fields must match. Click Submit to save these changes. 31 of 38
5.2.3 Dialing Rules Dialing Rules must be administered based on the users/extensions administered in Section 4.4 and Section 4.5. In this case, 4xx was the rule needed for the digital extensions going through the gateway and 2xx was the rule needed for the digital extensions directly connected to IP Office. To configure the Dialing Rules, click the Dialing Rules option on the Administrator Portal as shown in Section 5.2. Click Add a Rule. The default placeholder for the dialing rule is (x.) The new rule is displayed below the list of existing rules, with default Match, Translation Rule, and Excluded Ports entries. The new rule can then be edited in the same way as any other existing rule. 32 of 38
The Match Criterion in the first rule is 4xx, which matches a three-digit number beginning with 4. The second rule is 2xx which matches a three-digit number beginning with 2. The Translation Rule can be used to convert the key presses into an alternative sequence. This can be left at the default and was not needed for the dial pattern for the compliance testing. Dialing Rules here apply to all of the gateway ports by default. The Excluded Ports option allows the administrator to have ports to which the Dialing Rules do not apply. This was not used for the compliance testing and was left at the default of None. Click Submit (not shown here) to save changes. The screen below shows the new Dialing Rules once they were added and saved. 33 of 38
5.2.4 Telephone Status After the configuration of IP Office and the gateway is completed, the telephones are ready for use. When the Configure Handsets screen is chosen again from the Administrator Portal or the administrator hits the Refresh button, the SIP Status should be yellow and Active (meaning the telephone is registered), the Port Status should be green and Idle (meaning it is not in use). Any ports without telephones should indicate Unknown, Not Fitted, and Idle for the Type Detected, Port Status, and SIP Status fields. 34 of 38
6. General Test Approach and Test Results All feature functionality test cases were performed manually to verify proper operation. The following scenarios were tested using the test configuration diagram shown in Figure 1. The installation test cases were covered with the setup of IP Office and Portico TVA TM. The functionality test cases were performed manually. Various calls were placed to test basic features including calls between digital stations registered as SIP endpoints, calls between digital stations registered as SIP endpoints and directly connected digital endpoints, call-waiting, hold, conference, G.711 codec calls, G.729 codec calls, codec negotiation, transfer, and a longevity test. The transfer tests do not apply to the Siemens digital phones as they do not have a transfer button. The longevity test was a two-hour duration, nine-party conference call with periodic checks of audio paths and displays. The serviceability test cases were performed manually by disconnecting and reconnecting the Ethernet cable to the Portico TVA TM, rebooting the Portico TVA TM, and rebooting IP Office. The verification included manually making calls, checking the audio and displays, and verification that telephones returned to an idle state. All test cases passed. No errors detected. Observation: In order for 3-party (or greater) conferencing to work in conjunction with IP Office and the Portico TVA TM, the parameters below must be unchecked on the VoIP tab on each Extension on the IP Office: Allow Direct Media Path Re-invite Supported 35 of 38
7. Verification Steps This section provides the tests that can be performed to verify proper configuration of IP Office and Portico TVA TM. 7.1. Verify Port Activity For Portico TVA TM, check the port status and the SIP registration status of the telephones. From the Administrator Portal, select Configure Handsets. The example below shows a 3-party conference. Note the yellow and the Active status for both the Port Status and the SIP Status. 7.2. Verify Digital to SIP Conversion Place an incoming call from a directly-connected digital station to another digital station that has registered to Avaya IP Office through the gateway as a SIP extension. Verify dial tone, ringing, display updates, and audio call connection. 36 of 38
8. Conclusion Portico TVA TM was compliance tested with IP Office and multiple digital set types. Portico TVA TM successfully allowed digital telephones to register as SIP endpoints to IP Office. All test cases completed successfully. Please note the Observation in Section 6 for conferencing requirements. 9. Additional References This section references the IP Office and Portico TVA TM product documentation that are relevant to these Application Notes. The following Avaya product documentation can be found at http://support.avaya.com: [1] IP Office 5.0 Documentation CD, August 2009 The following Citel product documentation can be found at http://www.citel.com/support: [2] Citel s 12 and 24 Port Portico TVA Softswitch Integration Guide, G-SIP3DS-RUC; AH.2 [3] Citel s 12 and 24 Port Portico TVA Phone User Guide, G-SIP3DP-RUC; AG-3 [4] Citel s 12 and 24 Port Portico TVA Installation and Configuration Guide + Appendices, R4.00.0; G-SIP3D-RUC; AH.2 37 of 38
Avaya and the Avaya Logo are trademarks of Avaya Inc. All trademarks identified by and are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks are the property of their respective owners. The information provided in these Application Notes is subject to change without notice. The configurations, technical data, and recommendations provided in these Application Notes are believed to be accurate and dependable, but are presented without express or implied warranty. Users are responsible for their application of any products specified in these Application Notes. Please e-mail any questions or comments pertaining to these Application Notes along with the full title name and filename, located in the lower right corner, directly to the Avaya DevConnect Program at devconnect@avaya.com. 38 of 38