Application Notes for Configuring Avaya Flare® Experience on iPad with Avaya Aura® Communication Manager 6.2 and Avaya Aura® Session Manager 6.2 – Issue 1.0
Avaya Solution & Interoperability Test Lab
Abstract
These Application Notes describe the configuration of the Avaya Flare® Experience on iPad with Avaya Aura® Communication Manager 6.2 and Avaya Aura® Session Manager 6.2.
- Avaya Aura® Session Manager provides SIP proxy/routing functionality, routing SIP sessions across a TCP/IP network with centralized routing policies and registrations for SIP endpoints.
- Avaya Aura® Communication Manager operates as an Evolution Server for the SIP endpoints which communicate with Avaya Aura® Session Manager over SIP trunks.
These Application Notes provide information for the setup, configuration, and verification of the call flows tested on this solution.
1. Introduction
These Application Notes present a sample configuration for a network that uses Avaya Aura® Session Manager to support registration of Avaya Flare® Experience on iPad endpoints and enables connectivity to Avaya Aura® Communication Manager Evolution Server 6.2 using SIP trunks.
As shown in Figure 1, Avaya Aura® Session Manager is managed by Avaya Aura® System Manager. Flare Experience on iPad endpoints configured as SIP endpoints utilize the Avaya Aura® Session Manager User Registration feature and Avaya Aura® Communication Manager operating as an Evolution Server. Communication Manager Evolution Server is connected to Session Manager via a SIP signaling group and associated SIP trunk group.
For the sample configuration, Avaya Aura® Session Manager runs on an Avaya S8800 Server. Avaya Aura® Communication Manager 6.2 Evolution Server runs on a S8800 server with an Avaya 450 Media Gateway and an Avaya G650 Media Gateway. The results in these Application Notes should be applicable to other Avaya servers and media gateways that support Avaya Aura® Communication Manager 6.2.
These Application Notes will focus on the configuration of Avaya Flare® Experience in Communication Manager Evolution Server and Session Manager. Detailed administration of Communication Manager Evolution Server will not be described (see the appropriate documentation listed in Section 9).
For the Avaya Flare® Experience on iPad, Avaya expects an existing user to have a SIP Main extension (e.g., 41801) associated with a DID number. There would be a hard SIP phone in the office logged in as 41801. When using Flare on iPad, log in with this same SIP extension (41801).
In general, people will often have an H.323 VPN phone at home, and this H.323 extension would have a bridged appearance of the SIP hardphone extension in the office that is tied to the user's DID number.
To use the Avaya Flare® Experience on iPad from outside the corporate network, download Junos Pulse for iOS/iPad to connect to the corporate network.
2. Equipment and Software Validated
The following equipment and software were used for the sample configuration provided:
Equipment | Software Release |
---|---|
Avaya Aura® Communication Manager Avaya S8800 Server Evolution Server |
R016x.02.0.823.0-19926 |
Avaya Aura® System Manager Avaya S8800 Server |
Release 6.2.0 |
Avaya Aura® Session Manager Avaya S8800 Server |
Release 6.2.0.0.622005 |
Avaya Flare® Experience on iPad | Release: 1.0 Build: R1.0 NGUE-FLAREIOSATLINT-JOB1-113 |
Avaya G650 Media Gateway IP Server Interface TN2312BP Clan TN799DP IPMedpro TN2602AP Avaya G450 Media Gateway |
Hardware 15 Firmware 51 Hardware 01 Firmware 38 Hardware 08 Firmware 55 Hardware 1 Firmware 31.20.1 |
3. Avaya Flare® Experience on iPad Limitations
- SRTP: Not supported
- Supports audio only.
- There's no Drop button. The user has to press the red handset image when active on a call to end.
- Call Pickup is supported via Feature Access Code only.
- Call Park, and Bridged Call Appearance features: not supported.
- Dual registration and Failover: not supported. Remote iPad user is not supported with Avaya 3050 VPN Gateway.
- Hand-off from cellular to wifi or vice-versa: not support.
- Sipera support is very restricted w Flare iPad R1.0
4. Configure Avaya Aura® Session Manager
The following steps describe configuration of Session Manager for use with Flare Experience on iPad. The following section describes administering SIP Entities between Session Manager and the Communication Manager Evolution Server in order to establish a SIP Entity link between Session Manager and the Communication Manager Evolution Server. Administering the Flare Experience on iPad to register to Session Manager is also discussed.
4.1. Access Avaya Aura® System Manager
Access the System Manager web interface, by entering http://<ip-addr>/SMGR as the URL in an Internet browser, where <ip-addr> is the IP address of the server running System Manager graphical user interface. Log in with the appropriate Username and Password and press the Log On button to access System Manager.
The main menu of the System Manager Graphical User Interface is displayed in the following screen.
4.2. Administer SIP Domain
From the previous screen under the column Elements select Routing from the middle column of the main menu of System Manager. The following screen shows the configuration used to add a SIP Domain. The name of the SIP Domain used in Session Manager dr.avaya.com was added. The type was set to sip. Press the Commit button to add the SIP Domain.
4.3. Add Location
To add a new Location, click on Routing and access the Locations sub heading. A location Name 135.9.xxx was added to Session Manager. A Location Pattern of 135.9.xxx.* was also added. The Commit button was pressed to confirm changes. Locations are used to identify logical and physical locations where SIP entities reside for the purposes of bandwidth management or location based routing.
A location Name 20.20.20 was added to the Session Manager. A Location Pattern of 20.20.20.* was also added. The Commit button was pressed to confirm changes.
4.4. Administer Avaya Aura® Session Manager SIP Entity
Under Routing select the sub heading SIP Entities. The Session Manager SIP Entity is the first part of the link between Session Manager and Communication Manager Evolution Server. Enter the Name of the SIP Entity. For the test configuration, silasm3 was used. The FQDN or IP Address was set to 135.9.xxx.xxx (Note: IP address is partially hidden for security). This is the IP Address of the SIP Signaling Interface in the Session Manager server. The Type was set to Session Manager. The Location was set to 135.9.xxx, the Time Zone set to America/Denver and the SIP Link Monitoring was set to Use Session Manager Configuration. Press the Commit button.
The following screen shows what Port settings need to be configured for the SIP Entity. With the signaling protocol being set to TLS port 5061 was used in the SIP Entity SIP trunk. Press the Commit button.
4.5. Administer Avaya Aura® Communication Manager Evolution Server SIP Entity
The Evolution Server SIP Entity is the second part of the link between the Session Manager and Communication Manager Evolution Server. The Name of the SIP Entity was cm8. The FQDN or IP Address was set to 135.9.xxx.xxx (Note: IP address is partially hidden for security) which is the IP Address of the Evolution Server. The Type was set to CM for Communication Manager. The Location was set to 135.9.xxx and the SIP Link Monitoring was set to Use Session Manager Configuration. Press the Commit button.
4.6. Administer SIP Entity Link
To administer the SIP Entity link access the sub heading Entity Links on the left hand side of the System Manager GUI. The SIP Entity Link is the link between Session Manager and Communication Manager Evolution Server. SIP Entity 1, the Session Manager SIP Entity was called silasm3_cm8_5061_TLS. SIP Entity 2, the Evolution Server SIP Entity was called cm8. The protocol used for signaling purposes for the sip trunk was TLS and port number 5061 as shown in Section 4.4.
4.7. Administer Avaya Aura® Session Manager
In order to provide the link between Session Manager and System Manager, Session Manager must be added to the configuration. From the Home screen, under the Elements column select Session Manager. Under the Session Manager heading on the left hand side of the System Manager GUI click on the Session Manager Administration sub heading.
The SIP Entity Name was set to silasm3. The Management Access Point Host Name/IP was set to 135.9.xxx.xxx. This is the management IP Address for the server running Session Manager. Direct Routing to Endpoints was set to Enable. The SIP Entity IP Address was set to 135.9.xxx.xxx (Note: IP address is partially hidden for security). This is the IP Address of the SIP Signaling Interface in Session Manager. The Network Mask was set to 255.255.255.0 and the Default Gateway was set to 135.9.xxx.254.
4.8. Administer Avaya Aura® Communication Manager Evolution Server Application
In order for Communication Manager to supply configuration and feature support to SIP phones when they register to Session Manager, Communication Manager must be added as an application. From the Home screen, under the Elements column select Inventory. Under the Inventory heading on the left hand side of the System Manager GUI access the Manage Elements sub heading. The Name was set to cm8. The Type was set to Communication Manager. The Node was set to IP Address 135.9.xxx.xxx (Note: IP address is partially hidden for security).
4.9. Administer Avaya Aura® Communication Manager Evolution Server Application Sequence
To configure the Communication Manager Evolution Server Application Sequence expand Elements → Session Manager and select Application Configuration from the left navigation menu. To add the application access the Applications sub heading. The Name was set to CM8. Select the SIP Entity (already created) cm8 from the dropdown. The CM System for SIP Entity was set to cm8 from the View/Add CM Systems. This will be used later in administering the iPad Flare Experience as a SIP user in Session Manager in Section 4.12.
4.10. Administer Avaya Aura® Communication Manager Evolution Server Application Sequence
To configure the Communication Manager Evolution Server Application Sequence access Home, Elements column, Session Manager and then from the Session Manager heading on the left hand side System Manager GUI access the sub heading Application Configuration and then the sub heading ApplicationSequences. The Evolution Server Application Sequence Name was added as CM8. This will be used later in administering the Flare Experience on iPad as a SIP user on Session Manager in Section 4.12.
4.11. Synchronize Communication Manager Data
To synchronize the CM Data with Session Manager go to the Home screen and under the Elements column select Inventory. Under the Inventory heading on the left hand side select Synchronize and then select the sub heading Communication System. The following screen shows cm8. To begin the synchronization of the Communication Manager Evolution Server and the Session Manager highlight the Initialize data for the selected devices option and select the Now key.
4.12. Add SIP User
To add a user to the Session Manager access Home⇒Users column, User Management and then from the heading on the left hand side of the System Manager GUI access the sub heading Manage Users. For the sample configuration in the Identity tab for the SIP User added was Last Name with a value of Experience and First Name with a value of SIL iPad. The Login Name is the extension plus the domain 41801@dr.avaya.com in this scenario. Authentication Type is the default value of Basic. Add any New Password and Confirm Password.
Access the Communication Profile tab from the User Profile. For the Communication Profile Password enter value used to log in endpoint in the Communication Profile Password and Confirm Password fields. In the Communication Address the Type was set to Avaya SIP. The Fully Qualified Address was set as 41801@dr.avaya.com. Select the Add button to save the changes.
Check the Session Manager Profile box. The Primary Session Manager was set to silasm3 as shown below. This equates to the Session Manager SIP entity. The Origination and Termination Application Sequence was set to CM8. This is the Communication Manager Evolution Server Application Sequence name. The Home Location was set to 20.20.20. (Note: Flare Experience® on iPad does not support failover or Survivability).
In order for the Station Profile template information to be pushed from Session Manager down to Communication Manager Evolution Server, check the CM Endpoint Profile box. The System was set to cm8. This is the Communication Manager Evolution Server Element Name. The Profile Type was set to Endpoint. The Extension was set to 41801. For the Security Code interval value used to log in endpoint The Port was set to IP.
Click on Endpoint Editor and select the Feature Options tab. Enable IP softphone by placing a check in the box next to each respective feature. Select Done and Select Commit (not shown) when back to the main User Profile screen.
5. Administer Avaya Aura® Communication Manager Evolution Server
This section highlights the important commands for defining the Flare Experience iPad as an Off-PBX Station (OPS) and administering a SIP Trunk and Signaling Group to carry calls between Flare Experience on iPad in Communication Manager Evolution Server.
This section describes the administration of Communication Manager Evolution Server using a System Access Terminal (SAT). These instructions assume the G450 Media Gateway and G650 Media Gateway are already configured on Communication Manager Evolution Server. Some administration screens have been abbreviated for clarity.
5.1. Verify OPS Capacity
Use the display system-parameters customer-options command to verify that Maximum Off-PBX Telephones – OPS has been set to the value that has been licensed, and that this value will accommodate addition of the SIP telephones. If a required feature is not enabled or there is insufficient capacity, contact an authorized Avaya sales representative to obtain additional capacity.
display system-parameters customer-options
5.2. Administer Dial Plan Analysis
This section describes the Dial Plan Analysis screen. This configuration enables Communication Manager to interpret digits dialed by the user. The user can determine the beginning digits and total length for each type of call that Communication Manager needs to interpret. The Dialed String beginning with the number 41 and with a Total Length of 5 digits will be used to administer the extension range used for the Flare Experience on iPad.
displaydialplan analysis
5.3. Administer IP Node-Name
This section describes IP Node-Name. This is where Communication Manager assigns the IP Address and node-name to Session Manager. The node-name is silasm3 and the IP Address is 135.9.xxx.xxx.
5.4. Administer Signaling Group
This section describes the Signaling Group screen. The Group Type was set to sip and the Transport Method was set to tls. Since the sip trunk is between Communication Manager Evolution Server and Session Manager the Near-end Node Name is the node name of the "procr" of the Communication Manager Evolution Server. The Far-end Node Name is the node name of the Session Manager Server that is silasm3. The Near-end Listen Port and Far-end Listen Port are both set to port number 5061. The Far-end Network-Region was set to 1.
5.5. Administer Trunk Group
This section describes the Trunk Group used to carry calls between the Flare Experience on iPad. Trunk Group 10 was configured as a SIP Trunk with the Group Type set as sip. The trunk Group Name was set to SIP TG to silasm3. The TAC was set to #010. The Direction of the calls was set to two-way as there will be calls to and from the Flare Experience on iPad. The Service Type was set to tie as the trunk is an internal trunk between Communication Manager Evolution Server and Session Manager. The Signaling Group number assigned to this trunk is 10. The Number of Members assigned to this trunk group is 64. All other fields on this page are left as default.
On Page 3 of the trunk group form Numbering Format was set to private.
5.6. Administer IP Network Region
This section describes the IP Network Region screen. It was decided to place the Flare Experience on iPad in network region 1. The Authoritative Domain must mirror the domain name of Session Manager. This was dr.avaya.com. The codecs used on the SIP endpoints were placed in Codec Set 1. IP Shuffling was turned on so both Intra-region IP-IP Direct Audio and Inter-region IP-IP Direct Audio was set to yes.
5.7. Administer IP Codec Set
This section describes the IP Codec Set screen. IP Codec G.711MU, G.711A, G.729, and G.722-64k were used for testing purposes with the Flare Experience on iPad.
5.8. Administer Off PBX Telephone Station Mapping
This section shows the off-pbx-telephone station-mapping. The Flare Experience on iPad extension 41801 uses off-pbx Application OPS which is used for SIP enabled telephones. The SIP Trunk Selection is set to aar. The Config Set which is the desired call treatment was set to 1.
The Call Limit is set to 3 as shown below. This is the maximum amount of simultaneous calls for extension 41801. The Mapping Mode field was set to both in this configuration setup. This is used to control the degree of integration between SIP telephones. The Calls Allowed field was set to all. This identifies the call filter type for a SIP Phone. The Bridged Calls field was set to none as it was not needed for testing purposes.
5.9. Administer Station Screen
This screen describes the station form setup for the Flare Experience on iPad on Communication Manager. The Extension used was 41801 with phone Type 9640SIP. Phone type 9640SIP was the recommended phone type to use for the Flare Experience on iPad. The Name of the phone was set to Experience, SIL iPad and the IP SoftPhone was set to y, this is required for the Flare Experience on iPad. All other values on Page 1 of the station form were left as default.
5.10. Administer Private Numbering
This screen describes the private numbering form on Communication Manager. The Ext Len was set to 5 digits. The Extension Code was 41. The Total Length set to 5.
5.11. Administer AAR Analysis
This screen describes the aar analysis form setup for the Flare Experience on iPad on Communication Manager. When an extension beginning with 4 is dialed the aar analysis tables expects a minimum and a maximum of 5 digits. The aar analysis table routes the call to Route Pattern 10. The call type was aar.
5.12. Administer Routing Pattern
This screen describes the Route Pattern form setup for the Flare Experience on iPad on Communication Manager. Route Pattern sends the call out trunk 10.
6. Configure the Flare Experience on iPad
This section describes steps needed to configure and connect the Flare Experience on iPad to Session Manager. It's assumed the Flare Experience application is already loaded on the iPad and the iPad is already on the correct wireless network. Once the Flare Experience application is opened the following screen is displayed.
Press on the Settings option on the top of the Flare Experience application, see previous screen. The Settings menu appears with several options to configure the device, see screen below. Under the title Service press anywhere in the Server box. Enter the IP Address of the Session Manager's SIP Signaling Interface. Press anywhere in the Domain box. Enter the Domain of the network you are connecting to. Press on Done when finished. The main Flare Experience screen will be displayed again as in the previous screen.
Press on the Not logged in button as seen in the screen below. The Log In window will appear. Enter the Extension and Password that was administered in Section 4.12 under the Communication Profile tab. Press on the Log In button.
7. Verification Steps
The following five verification steps were tested using the sample configuration. The following steps can be used to verify installation in the field.
- Verified the Flare Experience on iPad extension 41801 was registered to the Session Manager. Verified the extension 41801 was logged in successfully to the Flare Experience on iPad.
- Verified a call could be made with clear audio between the Flare Experience on iPad. Verified the call was seen to be active on the SIP Trunk within Communication Manager. This was successful.
- Verified supplementary features such as Call Hold, Mute, and Conference could be completed between the Flare Experience on iPad. This was successful.
Access Elements⇒Session Manager⇒System Status⇒User Registrations to see the Flare Experience on iPad extension 41801 registered to Session Manager.
On the top left hand corner of the screen below the extension 41801 and Logged in is displayed. This means that the Flare Experience is now logged and is able to make/receive audio phone calls. Notice the other icons displayed including Collaboration, Conference, and Conference icons on the bottom right hand corner. These items are only displayed and functional with Flare Experience and not Flare Communicator.
From the screen below, a successful call was made from the Flare Experience on iPad.
8. Conclusion
These Application Notes have described the administration steps required to register Avaya Flare® Experience on iPad to Avaya Aura® Session Manager with Avaya Aura® Communication Manager running as an Evolution Server and make a successful audio call.
Interoperability testing included successfully making bi-directional calls between several different types of audio endpoints.
9. Additional References
- [1] “Avaya Aura® Session Manager Overview”, Document Number 03-603323, Release 6.2, February 2012
- [2] “Implementing Avaya Aura® Session Manager”, Document Number 03-603473, Release 6.2, February 2012
- [3] “Administering Avaya Aura® Session Manager”, Document Number 03-603324, Release 6.2, February 2012
- [4] “Maintaining and Troubleshooting Avaya Aura® Session Manager, Document Number 03-603325, Release 6.2, February 2012
- [5] “Installing and Upgrading Avaya Aura® System Manager”, Release 6.1, November 2010
- [6] “Administering Avaya Aura® System Manager”, Release 6.2, February 2012
- [7] “Avaya Aura™ Communication Manager Overview”, Document Number 03-300468, Issue 7, Release 6.0, June 2010
- [8] “Administering Avaya Aura® Communication Manager”, Document Number 03-300509, Issue 7.0, February 2012
- [9] “Avaya Aura® Communication Manager Feature Description and Implementation”, Document Number 555-245-205, Issue 9.0, February 2012
- [10] “Administering Network Connectivity on Avaya Aura® Communication Manager”, Document Number 555-233-504, Issue 16, February 2012
- [11] “SIP Support in Avaya Aura™ Communication Manager Running on Avaya S8xxx Servers”, Document Number 555-245-206, Issue 9, May 2009”