APPLICATION NOTE No

Transcription

1 APPLICATION NOTE No Date: August 2008 Author: Eli Shmulenson, ITC Solution Support Engineering Product: Avaya Distributed Office, Avaya Modular Messaging General: Avaya DO Private Networking and Modular Messaging Integration Table of Contents 1. Overview Use Case System Requirements Communication Manager Distributed Office SIP Enablement Services (SES) Modular Messaging Distributed Office Central Management Connectivity Method of Integration Configuration Steps Creating a Private Inter-Branch Network Setting Inter-Branch Network in the Headquarters Configure Avaya Communication Manager Configure SES Home Configuring Private Inter-Branch Network among Branches Access DOCM Management Screen Adding a Branch Set up Inter-Branch Private Network Verify Inter-Branch Configuration Setup Avaya Modular Messaging as Central Voice Messaging System Setting Voice Messaging System in the Headquarters Configure Avaya Communication Manager Configure the SES Home Configure the Message Application Server Configure Subscribers on the Message Storage Server Setting Distributed Office in the Branches Configure Coverage for Users Configure Voice Mail Access Number CID Page 1/49

2 1. Overview Although the Avaya Distributed Office (DO) system includes integrated local voice messaging system, some customers prefer using a central voice messaging system rather than distributed. This Application Note describes how to configure an inter-branch Avaya DO network with a centralized Avaya Modular Messaging system. This is implemented in two steps: a. Creating inter-branch network with local voice messaging systems in the branches. This step is described further in section 2. b. Setup Avaya Modular Messaging as central voice messaging system. This step is described further in section 3. Use this document in conjunction with Modular Messaging Installation Guide, Avaya PBX Administration Guide and with Avaya Distributed Office Installation Guide Use Case The inter-branch SIP network provides connectivity among all DO branches, the headquarters and the centralized voice messaging system. As the example in Figure 1 shows, this network includes the following components: Headquarters The main office location that includes the following components: Main office PBX system - based on Avaya Communication Manager, running on a Linux based server (S8x00) and all the affiliated hardware (Gateways, IPSI, CLAN, Media Processors, Trunk boards, etc.). The PBX has local trunks to the PSTN. As the HQ is part of the inter-branch network, it has its own unique prefix (100) that is used for inter-branch dialing. SES Core Router Avaya SIP proxy configured as Edge Proxy Server. This server accepts inter-branch calls and routes them to their destination based on the branch prefix. SES Home Avaya SIP proxy configured as Home Proxy Server of the Modular Messaging and the CM. The server is connected to the corporate IP network through which the CM will have a SIP trunk administered to. In real life installations, there could be more than one SES Home server on the network so it could be that the CM and the MM will be served by different SES Home servers. CID Page 2/49

3 Messaging Application Server (MAS) Centralized Modular Messaging Application Server, based on S3500 server. Messaging Storage Server (MSS) Modular Messaging MSS, based on S3500 server. Both MSS and MAS servers are connected via private network and the corporate network. Distributed Office Central Management (DOCM) A central management system running on a Windows 2003 server, used for configuring inter-branch private networking and various DO functions. Branches Avaya DO systems installed in each branch, serving the local phones and can have local public trunks to the PSTN. Each Branch has its unique prefix (101 for branch A and 102 for branch B) that is used for inter-branch dialing. Each branch can have a Distributed Office Local Management system. This example includes only two branches (A and B) but there can be many more in a real life implementations. Distributed Office Local Management (DOLM) A local management web interface to the DO devices in the branches. Allows the user local branch functionality configuration and maintenance. CID Page 3/49

4 Avaya CM Headquarters (Prefix 100) Message Storage Server PSTN Message Application Server Distributed Office Local Management (DOLM) Branch A (Prefix 101) Media Gateway SIP SIP Avaya DO Inter-branch SIP Network SES Home SES Core Router (Edge) Branch B (Prefix 102) Avaya DO Distributed Office Local Management (DOLM) - Figure 1 - Distributed Office Central Management (DOCM) This document includes relevant configuration that has to be done, based on the example above System Requirements Communication Manager Avaya CM 3.1.4, 4.0.1, 5.0 or later running on Linux-based S8x00 platform S8500/S87x0: TN2302 or TN2602AP IP Media Processor, TN799D CLAN S8300: G250/G350/G700 on-board VOIP processor or MM760 Valid license Distributed Office i40 or i120 Software version 1.2 or above CID Page 4/49

5 SIP Enablement Services (SES) At least two Linux-based S8500 platforms SIP Enablement Services 5.0: o At least one system configured as SES Home o One system configured as SES Edge Valid license Note: Combo Home/Edge SES systems are not supported in Distributed Office environments Modular Messaging S3500 platforms MM 3.1 SP1 Patch MM and MM Valid license Must be obtained prior to installing the SIP integration and must be imported prior to testing/operation of the system Distributed Office Central Management PC server w/ Intel Pentium 4@3GHz CPU or better, w/ 2GB RAM Windows 2003 Server Operating System Distributed Office Central Management version Connectivity Within the branches Ethernet LAN with TCP/IP Inter-Branch network Ethernet LAN or WAN with TCP/IP 1.3. Method of Integration The connectivity among Avaya DO branches and Avaya CM is achieved via the SES Core Router proxy. The connectivity between Avaya CM and the MAS is achieved over an IPconnected SIP trunk via the SES Home proxy. CID Page 5/49

6 1.4. Configuration Steps This document describes two configuration steps: Creating Inter-Branch Network with Avaya CM and Avaya Distributed Office installations, described in Chapter 2. Setting up an Avaya Modular Messaging system as a centralized voice messaging system for the HQ and all the branches, described in Chapter 3. Note: Setting physical and IP connectivity among the branches is beyond the scope of this document. CID Page 6/49

7 2. Creating a Private Inter-Branch Network The example network in Figure 1 includes one main office (HQ) in which an Avaya CM system is installed and two branch offices with Avaya DO, based on the following dial plan: Branch Prefix Ext. Length Headquarters Branch A Branch B For example, if a person in branch A wants to call extension in the HQ, then he would dial: (where 8 is the AAR feature access code). Note: Variant branch prefix length is not supported Setting Inter-Branch Network in the Headquarters Configure Avaya Communication Manager This section describes the required configuration in the Avaya CM system installed in the HQ. All the commands discussed in this section are executed on CM using SAT. Prior to SIP and MM related configuration, it is required that the following tasks will be configured in the following order when programming the PBX: Note: Description of configuring these tasks is beyond the scope of this document. Verify customer options for SIP trunking Assign Local Node Number Administer CLAN and IP-Media Processor circuit packs (S8500/S87x0 only) Assign IP node names and IP addresses to CLAN, IP Media Processor (S8500/S87x0 only) Define IP interfaces (S8500/S87x0 only) Configure dial plan Configure public trunks Configure local extensions Configure AAR/ARS Analysis Tables Configure AAR/ARS Digit Conversion Tables Define Public Numbering CID Page 7/49

8 Create Route Patterns for public trunks Create a an sesuser profile to access the CM Setup license After completion of the above tasks, you may proceed to the following configuration steps: Verify Customer Options Make sure the obtained CM license file enables SIP trunking and the other options described in the following SAT screens: Note: One SIP trunk is used for each call to/from another branch. CID Page 8/49

9 CID Page 9/49

10 Define IP Network Regions and Codec Sets In our example, network region 1 is selected. Define the local domain for the SIP network. In this example, avaya.com is used. As all entities beyond the SIP trunk should belong to Network Region 2, define IP Codec Sets 2 for inter-region communication. CID Page 10/49

11 Configure Codec Set 1: Set the 1 st priority codec to G.711MU. CID Page 11/49

12 Configure Codec Set 2: Set the 1 st priority codec to G.729 and the 2 nd priority codec to G.711MU Add SES Home Server to the Node Names Add the SES Home proxy to the IP Node Names. Enter the IP address assigned to the SES Home. CID Page 12/49

13 Create a Signaling Group for SIP The Near-end Node Name is the name assigned to the local CLAN. The Far-end Node Name is the name of the assigned SES Home server. For this example, signaling group 2 was selected using TLS transport with port CID Page 13/49

14 Create a Trunk Group for SIP In this example, trunk group 25 was created as a SIP trunk, using the above signaling group and ten trunk members. CID Page 14/49

15 Create a Route Pattern Create a Route Pattern for the SIP trunk group created earlier. For this example, it is Route Pattern 25. Ensure Secure SIP is set to n (sets the calls as TLS end-to-end). CID Page 15/49

16 Set Incoming Call Treatment The Communication Manager has to remove the HQ branch prefix (100) from incoming calls via the SIP trunk. CID Page 16/49

17 Modify the AAR Analysis Table All inter-branch calls should be routed via the AAR table. In then given example 101 and 102 are branch prefixes for inter-branch dialing. CID Page 17/49

18 Configure SES Home The SES Home server is the SIP proxy server serving the CM for inter-branch SIP connectivity, as well as for Modular Messaging integration (see Chapter 3) and for other SIP related functions. This section describes the required configuration in the SES Home system installed in the HQ. Prior to CM and MM related configuration, it is required that the following tasks will be configured on the SES Home system: Note: These tasks configuration description is out of scope of this document. Initial setup, including IP addressing configuration. Setup the host as Home Proxy Setup Master Administration (on the SES Edge) Configure Hosts (Homes, Edge) Setup license After completion of the above tasks, you may proceed with the next configuration steps. SES Home administration always takes place on the Edge and is pushed to the Home. Therefore, to configure SES Home features it is required to access to the SES Edge Web interface. CID Page 18/49

19 Add Media Server The SES Home proxy is the other end of the SIP trunk previously configured on the Avaya CM system in the HQ. Starting from the SIP Management page, perform the following actions: Click Media Servers Click Add another Media Server Interface The Host is the Home proxy SIP Trunk Type should be TLS SIP Trunk Address refers to the CLAN/PROCR IP address of the node shown on the previously defined SIP Signaling Group. Media Server Admin Address refers to the PROCR or the actual server address used for server management. Media Server Admin Login and Password should not be ASG challenged, as SES cannot perform ASG authentication when it talks to CM. This login/password is used to login to CM and download PPM information to SES. This login needs to be created in CM (it is the sesuser login). CID Page 19/49

20 Set Mapping to the Media Server The mapping is required in order for the SES Home server to route incoming SIP messages to the relevant media server, based on the destination number. From the list of media servers: Click on Map of the interface just created to define an address map. Click on Add another Map and enter the name and pattern that will map to the desired extensions on the PBX. Fill in the Pattern field a regular expression that fits the dial plan in the HQ. In the example below the expression means that all incoming SIP messages targeted for 100XXXXX will be routed to this media server. The 100 is the HQ branch prefix and the following five digits are the extension number. CID Page 20/49

21 2.2. Configuring Private Inter-Branch Network among Branches So far, you configured inter-networking only in the HQ. Now you need to configure an Inter-Branch Network in other branches as well as in the SES Core Router (Edge). For this purpose the Distributed Office Central Management (DOCM) application will be used Access DOCM Management Screen Access the DOCM application by pointing a web browser to the DOCM server IP address. Choose the Distributed Office Central Manager link from the launch page that is displayed. Then go through the login process. CID Page 21/49

22 Adding a Branch After passing the login screen a welcome screen will appear. On the left side of the screen a list of Managed Objects will be displayed. Click on the Branches object on the left. Click Add. Enter the Branch Name. Enter the branch IP address (refers to the DO server IP address). Enter Admin username and password for managing the branch DO server (same as used for accessing the DO via the DOLM). Click Test Connectivity. If the test passes then the IP connectivity and the data entered to access the branch is correct. Click Save Changes. CID Page 22/49

23 A Schedule dialog box will appear. Select Run now and click OK. The Add Branch job was scheduled to run immediately. Now check the job s status: Click on the Jobs object on the left. A list of scheduled jobs will be displayed. Find the Add Branch job and track its status. Use Refresh button to update the screen. The status should change from Planned to Active. When status changes to Completed then the branch was added successfully. Notes: If the job failed, try finding the cause by clicking on the job entry and then on the Operations tab. If the job fails, you need to add the branch again as described above. Repeat this procedure for all the DO branches in the network. CID Page 23/49

24 Set up Inter-Branch Private Network By completing this step the DOCM automatically configures all the DO servers in the branches and the SES Core Router. Click on the Enterprise object on the left. Click on Private Networking. Check the Enable Private Networking checkbox. Click the General tab. Enter the Domain Name as was previously defined in the IP Network Region and in SIP Signaling Group screens in the HQ CM. In our example we set the SIP domain as avaya.com. Set the branch prefix length. In our example all branch prefixes are three digits long. Note: All branches, including the headquarters, must have the same Prefix Length. Click the SES tab. Enter the IP address of the SES Core Router (Edge) Enter the Management Access Login and Password. This should be the same as entered in the SES Core Router s System Properties web screen. Click Test Connectivity to make sure the DOCM server can access the SES Core Router. In case the test fails check the SES Core Router s configuration by going through its web management interface to the SES Administration->Server Configuration->System Properties screen. CID Page 24/49

25 Click the SIP Servers tab. Click Add Row. Enter the host name and the IP address of the SES Home proxy. Enter the branch prefix of the Headquarters. In our example it is 100. Enter the extension length in the Headquarters, as configured in the HQ CM dialplan. In the given example, all extensions in the HQ are five digits long. Note: Extensions length can vary from branch to branch. CID Page 25/49

26 Click the Branches tab. All the DO branches previously entered should appear in the displayed Private Network Branches list. For each branch enter its Prefix number. In our example we use prefix 101 for Branch A and 102 for Branch B. Make sure the extension length is displayed correctly. Click Save Changes. A Schedule dialog box will appear. Select Run now and click OK. CID Page 26/49

27 The Private Network Config job was scheduled to run immediately. Now check the job status: Click on the Jobs object on the left. A list of scheduled jobs will be displayed. Find the Private Network Config job and track its status. Use Refresh button to update the screen. The status should change from Planned to Active. When status changes to Completed then the private inter-branch network was setup successfully. Notes: If the job fails, try finding the cause by clicking on the job entry and then on the Operations tab. If the job fails, reconfigure the Private Networking as described above Verify Inter-Branch Configuration To verify the DOCM has configured the SES Core Router with the branch prefixes, access the SES Core Router (Edge) web administration page, and Click on Core Router. Click on Prefix Map. This will display a List Prefix Map with the headquarters and all the branches. The Branch Address stands for the SES Home and DO and the Total Length includes the branch prefix and the extension length of the branch. CID Page 27/49

28 You can also use Distributed Office Local Management (DOLM) to verify that all the branches have accepted the SIP Domain, SES Core Router and their branch prefix information. Accessing each branch DO DOLM is done by pointing a web browser to the DO server IP address. After going through the login screen, a welcome screen will be displayed. Click Maintenance and Monitoring. Click System Summary. CID Page 28/49

29 If all the branches correctly displayed in the table, you can test Inter-Branch dialing, according to the following examples: Dialing from Branch A to ext in HQ: Dialing from HQ to ext. 332 in Branch B: Dialing from Branch B to ext. 412 in Branch A: Notes: When dialing from a DO extension to another branch over the Inter-Branch Private Network, you need to use an AAR access code. The default AAR access code in DO is 8. It is assumed that the same AAR access code is configured in the HQ CM. Use change features-access-codes SAT screen for setting access codes in CM. Please use real extension numbers while testing. CID Page 29/49

30 3. Setup Avaya Modular Messaging as Central Voice Messaging System The example network in Figure 1 includes one main office (HQ) in which an Avaya CM system is installed and two branch offices with Avaya DO. By default, each DO has its local integrated voice messaging system. This chapter describes how to setup a centralized voice messaging system, based on Avaya Modular Messaging servers, instead of the integrated ones. Note: Before proceeding, please make sure the Private Inter-Branch Networking is configured correctly and is fully functional Setting Voice Messaging System in the Headquarters Note: If your deployment does not involve a Communication Manager then skip directly to paragraph Configure Avaya Communication Manager This section describes the required configuration in the Avaya CM system installed in the HQ. All the commands discussed in this section are executes on CM using SAT. This section assumes that you have completed all the configuration described in section Verify Class of Service Make sure Trunk-to-Trunk Transfer Override is set to yes. This will override any system and/or COR-to-COR calling party restrictions that would otherwise prohibit the trunk-to-trunk transfer operation for users with this COS. With Trunk-to-Trunk Override transfer enabled, the Avaya Modular Messaging attendant (or any other user) can connect at incoming trunk call to an outgoing trunk. Use this COS with caution, as the ability to perform trunk-to-trunk transfers greatly increases the risk of toll fraud. CID Page 30/49

31 Create a Hunt Group Configure a Hunt Group to be used as the Call Coverage Point for the Call Coverage Path assigned to MAS subscriber. In the Group Extension field fill in the pilot number (the number that has to be dialed to access the Modular Messaging system). In our example the number is 705. CID Page 31/49

32 On page 2, enter sip-adjunct as the Message Center, indicating the type of messaging adjunct used for this hunt group. The voice mail handle domm will be used by the proxy in a later step. In the Routing Digit field of this form enter the PBX s AAR feature access code. Notes: Only the handle domm should be used. The default AAR access code in DO is 8. It is assumed that the same AAR access code is configured in the HQ CM. Use change features-access-codes SAT screen for setting access codes in CM. CID Page 32/49

33 Create a Coverage Path Set up a coverage path for the subscriber s extension. Assign to it the pilot hunt group number created in the earlier step. CID Page 33/49

34 Update AAR Digit Analysis Table For the AAR Digit Analysis table, create the dial string that will map calls to Avaya Modular Messaging via the route pattern previously created. The dialed string created in the AAR Digit Analysis table should contain a map to the pilot number of the Avaya Modular Messaging system. The value 705 is the voice mail pilot number that has dialed to access Avaya Modular Messaging. CID Page 34/49

35 Define Numbering This step is required for the Call Sender feature on Avaya Modular Messaging. This allows the CM to send the calling party number along with the call information. The dial plan used in our example includes 5-digit extensions that have pattern 5xxxx. In the above example, the CPN Prefix is the branch prefix of the HQ (see Figure 1) and the total length is eight digits (CPN Len). CID Page 35/49

36 Subscriber Station Administration For each subscriber extension, the Coverage Path and Message Lamp Ext must be specified. An example extension for an Avaya 4621SW IP phone is shown below. On page 2, set the MWI Served User Type field to sip-adjunct. CID Page 36/49

37 Configure the SES Home This section covers the administration of Avaya SES for integration with Avaya Modular Messaging. SES Home administration always takes place on the Edge and is pushed to the Home. Therefore, you need to access to the SES Edge Web interface in order to configure SES Home features. Perform the following configuration tasks on the SES Home system before CM- and MM-related configuration: Note: Describing these tasks is beyond scope of this document. Initial setup, including IP addressing configuration. Setup the host as Home Proxy Setup Master Administration (on the SES Edge) Configure Hosts (Homes, Edge) Setup license After completion of the above tasks and the configuration tasks described in Chapter 2, you may proceed with the next configuration steps. In this step the Avaya Modular Messaging system is configured as a SIP Adjunct System in the SES Home. Starting from the SIP Management page, perform the following actions: Expand Adjunct Systems. Click Add. In the System Name field enter: domm Select the SES Home address as the Host. Check the Replace URI check box. Click Add and Continue. CID Page 37/49

38 The list of available Adjunct Systems is now displayed. CID Page 38/49

39 Note: If you are integrating your DO System with an existing SES system that has modular messaging configured and is using a different Application ID, the following should be done: Under Adjunct Systems add an Application ID for "domm. This allows the DO system access to Modular Messaging using the configuration described in this application note. Click on List Adjunct Servers for the system just defined above. Click on Add Another Adjunct Server to System domm In the Server Name and ID field enter the name of the MAS. Select TLS as the Link type. Enter the IP address of the MAS server Click Add and Continue. After completing the above process the following screen should be displayed: CID Page 39/49

40 CID Page 40/49

41 Configure the Message Application Server There are number of parameters that must be set in the Voice Mail Domain of Avaya Modular Messaging. These changes are made through the Voice Mail System Configuration application on the MAS server. This section assumes that the MAS is installed and configured on Avaya S3500 server. Refer to Modular Messaging Software Message Application Server Guide for more information Configure Transfer/Outcall Start the application by selecting Start -> Programs -> Avaya Modular Messaging -> Voice Mail System Configuration Select Voice Mail Domains and expand the Voice Mail Domain defined during installation of the MAS server. Select PBXs and double-click the Avaya CM (IP SIP) listed to modify properties. Select the Transfer/Outcall tab and set Transfer Mode to Full. The Full setting prevents callers from being disconnected when calls are re-routed back to the MM. Transfers should only be administered as blind or partial when the transferred to numbers will not be re-routed to the message server. Click OK. CID Page 41/49

42 Configure Message Waiting Indicator Double-click on the Message Waiting Indicator option and select Enable Message Waiting Indicator (MWI) option to enable MWI feature with the options defined below. Click OK. The MAS will prompt to restart the services, but do not restart at this stage. CID Page 42/49

43 Configure Audio Encoding Double-click the Audio Encoding option and select G.711 mu-law. This setting must match the Avaya CM IP Codec Set, as previously defined in section for IP Codec Set 2 second priority. From the Voice Mail Domain expand Message Application Servers and expand the MAS listed (i.e. MAS-SIT) to be modified. Double-click Telephone Interface (IP SIP). Set the Playback Volume to the desired level and check the port numbers to be used. Click OK. CID Page 43/49

44 Configure PBX Integration Double-click on PBX Integration The Corporate IP Address is the address assigned to MAS. SIP Domain, as previously configured in Network Region and SIP Signaling Group in CM RTP Port Range The minimum and maximum UDP port numbers to specify for real-time protocol. Use the range 7000 to TLS Port Number is usually TCP Port Number is usually Under SIP Proxies, for the Avaya SES in the network, select the checkbox and enter the IP address/fqdn of the SES Home proxy server. Should be set to use TLS port Click OK. Restart the MAS before continuing. CID Page 44/49

45 Configure PBX Type Double-click PBX Type and access the General tab. Select IP SIP for Telephony Type. Verify that Avaya CM (IP SIP) is selected under PBX. Click OK. Restart Message Application Server services to apply the changes. CID Page 45/49

46 Configure Subscribers on the Message Storage Server The subscribers mail boxed are defined in the MSS. This section assumes that the MSS is installed and configured on Avaya S3500 server. Refer to Modular Messaging Software Message Application Server Guide for more information. Managing MSS is done through the MSS web interface. There is nothing unique about Avaya Modular Messaging subscriber configuration except that PBX Extension should include the branch prefix and the extension. According to the example given in this document, the PBX extension for extension in the HQ will actually be configured as PBX Extension For example: Branch Prefix Extension PBX Extension * Numeric Address * Mailbox Number * Notes: As extension can theoretically exist in more than one branch. Including branch prefix as part of the PBX Extension will make it unique. Mailbox number must be with a fixed length and unique for the system. Actually all the PBX extensions belong to HQ users will start with 100, while those belong to Branch A will start with 101 and so on. The Mailbox Number could be any number as long as it is unique and meets the mailbox number ranges for this MSS. CID Page 46/49

47 3.2. Setting Distributed Office in the Branches By default, call coverage in the branch DO is to the local DO integrated voice mail system. Any changes in the local branch DO system can be made using the Distributed Office Local Manager (DOLM). Accessing DOLM is made by pointing a web browser to the IP address of the DO server, or by using its Services port by pointing the browser to the fixed services IP address ( Configure Coverage for Users After going through the login screen, a welcome screen will be displayed. Under Configuration object, click Users. A list of existing defined users will be displayed. If no users exist then the list will be empty. Click on an existing user or on Add User in case a new user has to be defined. Under General tab define the user s details, extension number, security code, etc. Under Voic tab set Personal Mailbox to Remote Mailbox. CID Page 47/49

48 Under Station tab set Coverage to Remote Voic . Click Apply Changes. Click Save Configuration. Repeat the above steps for all users who need to use Modular Messaging as their voice mail system in all DO branches. CID Page 48/49

49 Configure Voice Mail Access Number Under Configuration object, expand Call Handling. Click Service Numbers. Note there is a different number for Local Voice Mail (i.e. 700) and Remote Voice Mail (i.e. 705). Click on Remote Voice Mail if you wish to change the access number. Then click Apply Changes and Save Configuration. CID Page 49/49