This document is for Avaya Aura 7.x Communication Manager & Session Manager Sip Integration This application notes contain instruction for configuring DuVoice VS6 with Avaya Aura® Communication Manager and Avaya Aura® Session Manager Version 7. The DuVoice system connect through the Session manager in order to make and receive calls on the call manager using SIP.

• Maid Status updates
• Do no disturb
• Guest Name update on phones
• Guest calling restriction control
• Guest wakeup
• Failed wakup alerts
• Guest and staff voice messaging
• Automated Attendant
• Message waiting indication controls

• Avaya Aura® Communication Manager version 7.0 SP2
• Avaya Aura® Session Manager Version 7.0.1 SP2
• Avaya Aura® System Manager version 7.0.1.1
• DuVoice version 6.0.

These Application Notes contains interoperability instructions for configuring DuVoice VS6 with Avaya Aura® Session Manager 10.x and Avaya Aura® Communication Manager 10.x.

• Communications manager - licensing
• Communications manager - IP Network Region
• Communications manager - IP-Codec-Set
• Communications manager - SIP Signaling Group
• Communications manager - IP Node Names (not in avaya doc)
• Communications manager - SIP Trunk Group
• Communications manager - Route Pattern
• Communications manager - Hunt Group
• Communications manager - Coverage Path
• Communications manager - Private Numbering
• Communications manager - AAR Analysis
• Communications manager - Rooms and admin extension for the DuVoice server

Use the change ip-network-region n command to configure a network region, where n is an existing network region.

Configure this network region as follows:

• Set Location to 1
• Set Codec Set to 1
• Set Intra-region IP-IP Direct Audio to yes
• Set Inter-region IP-IP Direct Audio to yes
• Enter and Authoritative Domain, e.g. avaya.com

Use the change ip-codec-set n command to configure IP codec set, where n is an existing codec set number.

Configure this codec set as follows, on Page 1:

• Set Audio Codec 1 to G.711MU

Use the change node-names ip command to add an entry for Session Manager. For compliance testing, sm and 10.64.10.61 entry was added.

Use the add signaling-group n command to add a new signaling group, where n is an available signaling group number.

Configure this signaling group as follows:

• Set Group Type to sip
• Set Near-end Node Name to procr
• Set Far-end Node Name to the configured Session Manager in the Administer IP Node Names Section, i.e. sm
• Set Far-end Network region to the configured region in the Administer IP Network Region Section, i.e. 1
• Enter a Far-end Domain, e.g. avaya.com

Note: Signaling Group, Trunk Group and Route Pattern for simulated PSTN calls for inter-site calls over ISDN/PRI and SIP were pre-configured and are not shown in this document. SIP Trunk Group

Use the add trunk-group n command to add a trunk group, where n is an available trunk group number.

Configure this trunk group as follows, on Page 1:

• Set Group Type to sip
• Enter a Group Name, e.g. SM
• Enter a valid TAC, e.g. *001
• Set Service Type to tie
• Enter Signaling Group value to the signaling group configured in the Administer SIP Signaling Group Section, i.e. 1
• Enter a desired number in Number of Member field

On Page 3:

• Set Number Format to private

Use the change route-pattern n command to configure a route pattern, where n is an available route pattern.

Configure this route pattern as follows:

• Type a name in Pattern Name field
• For line 1, set Grp No to the trunk group configured in the Administer SIP Trunk Group Section, i.e. 1
• For line 1, set FRL to 0

Use the add hunt-group n command to configure a hunt group, where n is an available hunt group number.

Configure the hunt group as follows:

• Type a descriptive name in Group Name field
• Type in a available extension number for Group Extension

On Page 2 of the hunt group, set the Message Center field to sip-adjunct. Set the Voice Mail Number and the Voice Mail Handle fields to the digits used to route calls to DV server and set the Routing Digits field to the AAR access code. In this example, the AAR feature access code was used to route calls.

Use the add coverage path n command to add a coverage path, where n is available coverage path number.

Configure the coverage path as follows:

• Under COVERAGE POINTS, for Point1 type in the hunt group that was configured in previous section. e.g., h6, where h stands for hunt group and 6 is the hunt group number.

Use the change private-numbering 1 command to define the calling party number to send to Session Manager.

Configure private numbering as follows: • Add entries for trunk group configured in the SIP Trunk Group Section

Note: For compliance testing, 5-digit hunt group extension 25099 routed over trunk groups 1 resulted in a 5-digit calling party number.

Use the change aar analysis n command to configure routing for hunt group extension number n. For compliance testing, hunt group extension 25099 was used for routing calls to DuVoice VS6.

• Set Dialed String to hunt group extension, e.g. 25099
• Set Min and Max to 5 for 5 digit extensions
• Set Route Pattern to pattern configured in the Route Pattern, i.e. 1
• Set Call Type to aar

Note: An entry to dial plan will need to be added for extension range used in this step.

Configuration of Avaya Aura® Session Manager is performed via Avaya Aura® System Manager. Access the System Manager Administration web interface by entering https://<ip-address>/SMGR URL in a web browser, where <ip-address> is the IP address of System Manager.

• Log in using appropriate credentials.
• Session Manager - Sip Domain
• Session Manager - Add Location
• Session Manager - Add Adaptation Module
• Session Manager - Add Sip Entities
• Session manager - Add Entity Links
• Session manager - Add Routing Policies
• Session Manager - add Dial Patterns

Create a SIP domain for each domain for which Avaya Aura® Session Manager will need to be aware in order to route calls. For the compliance test, this includes the enterprise domain (avaya.lab.com).

To add a domain Navigate to Home>Elements>Routing>Domains in the left-hand navigation pane and click the New button in the right pane (not shown). In the new right pane that appears (shown below), fill in the following:

  Name: Enter the domain name.
  Type: Select sip from the pull-down menu.
  Notes: Add a brief description (optional).

Click Commit. The screen below shows the entry for the enterprise domain.

Locations can be used to identify logical and/or physical locations where SIP Entities reside for purposes of bandwidth management and call admission control. To add a location, navigate to Routing>Locations in the left-hand navigation pane and click the New button in the right pane (not shown).

In the General section, enter the following values. Use default values for all remaining fields:

• Name: Enter a descriptive name for the location.
• Notes: Add a brief description (optional).

In the Location Pattern section, click Add and enter the following values. Use default values for all remaining fields:

• IP Address Pattern: An IP address pattern used to identify the location.
• Notes: Add a brief description (optional).

The screen below shows the addition of the Location, Click Commit to save.

Repeat the preceding procedure to create a separate Location for the DuVoice Server. The screen below shows the addition of the DuVoice location, which specifies the specific inside IP address for the DuVoice Server. Click Commit to save.

A SIP Entity must be added for Avaya Aura® Session Manager and for each SIP telephony system connected to it which includes Avaya Aura® Communication Manager and the DuVoice server. Navigate to Routing>SIP Entities in the left-hand navigation pane and click on the New button in the right pane (not shown).

In the General section, enter the following values. Use default values for all remaining fields:

• Name: Enter a descriptive name.
• FQDN or IP Address: Enter the FQDN or IP address of the SIP Entity that is used for SIP signaling.
• Type: Select Session Manager for Session Manager, CM for Communication Manager or Other. Use Other for DuVoice.
• Adaptation: This field is only present if Type is not set to Session Manager. If applicable, select the Adaptation Name created in the previous section that will be applied to this entity.
• Location: Select one of the locations defined previously.
• Time Zone: Select the time zone for the location above.

To define the ports used by Avaya Aura Session Manager, scroll down to the Port section of the SIP Entity Details screen. This section is only present for Session Manager SIP entities.

In the Port section, click Add and enter the following values. Use default values for all remaining fields: Port: Port number on which the Session Manager can listen for SIP requests. Protocol: Transport protocol to be used to send SIP requests. Default Domain: The domain used for the enterprise.

Defaults can be used for the remaining fields. Click Commit to save.

For the compliance test, only two Ports were used:

• 5060 with UDP for connecting to DuVoice.
• 5070 with TCP for connecting to Avaya Aura® Communication Manager.

Note: In a customer environment the entity link to Avaya Aura® Communication Manager would normally use TLS. For the compliance test, TCP was used to aid in troubleshooting since the signaling traffic would not be encrypted.

The following screen shows the addition of Session Manager. The IP address of the virtual SM- 100 Security Module is entered for FQDN or IP Address.

The following screen shows the addition of Avaya Aura® Communication Manager.

A separate SIP entity for Avaya Aura® Communication Manager, other than the one created for Avaya Aura® Session Manager during installation, is required in other to send traffic to and from Avaya Aura® Communication Manager.

The FQDN or IP Address field is set to the IP address of the Avaya S8300D Server running Avaya Aura® Communication Manager. For the Adaptation field, select the adaptation module previously defined for dial plan digit manipulation in the previous section. For the Location field, select the location for Avaya Aura® Communication Manager and Avaya Aura® Session Manager previously defined.

The following screen shows a portion of the list of adaptations in the sample configuration. Two adaptations were used for DuVoice, an incoming adaptation (for incoming calls from DuVoice) and an outgoing adaptation (for outgoing calls to DuVoice).

The adaptations named DuVoice Incoming and DuVoice Outgoing Adaptations were configured and used in the compliance test.

Settings for DuVoice Outgoing Adaptation:

In the General section, enter the following values. Use default values for all remaining fields:

  Adaptation Name: Enter a descriptive name for the adaptation.
  Module Name: Enter DigitConversionAdapter.
  Module parameter: Enter odstd=x where x is the IP address of the DuVoice server.

The odstd=172.16.5.125 module parameter enables the outbound destination domain to be overwritten with the IP address of the DuVoice server. For example, for outbound calls from Avaya to DuVoice, the Request-URI will contain IP address 172.16.5.125 as expected by DuVoice.

Click Commit to save.

The DuVoice Outgoing adaptation shown below will later be assigned to the DuVoice SIP Entity. This adaptation uses the DigitConversionAdapter.

The adaptation named DuVoice Incoming shown below will later be assigned to the SIP Entity for calls destined to Avaya Aura® Communication Manager. This adaptation uses the DigitConversionAdapter and specifies the osrcd=avaya.lab.com parameter to adapt the domain to the domain name expected by Avaya Aura® Communication Manager. More specifically, this configuration replaces the domain in the From header and P-Asserted-Identity header with the given value. For example, for inbound calls from DuVoice to Avaya, the From header sent to Avaya Aura® Communication Manager will contain the domain avaya.lab.com as expected by Avaya Aura® Communication Manager.

Settings for DuVoice Incoming Adaptation:

In the General section, enter the following values. Use default values for all remaining fields:

• Adaptation Name: Enter a descriptive name for the adaptation.
• Module Name: Enter DigitConversionAdapter.
• Module parameter: Enter osrcd= x where x is the domain name used.

A SIP trunk between Avaya Aura® Session Manager and a telephony system is described by an entity link. Two entity links were created; one to Avaya Aura® Communication Manager to be used only for DuVoice traffic to and from Avaya Aura® Communication Manager and one to the DuVoice server. To add an entity link, navigate to Routing>Entity Links in the left-hand navigation pane and click on the New button in the right pane (not shown). Fill in the following fields in the new row that is displayed:

• Name: Enter a descriptive name.
• SIP Entity 1: Select the Avaya Aura® Session Manager.
• Protocol: Select the transport protocol used for this link.
• Port: Port number on which Session Manager will receive SIP requests from the far-end. For Communication Manager, this must match the Far-end Listen Port defined on the Communication Manager signaling group in the previous sections.
• SIP Entity 2: Select the name of the other system. For Communication Manager, select the Communication Manager SIP entity defined in the previous sections.
• Port: Port number on which the other system receives SIP requests from the Session Manager. For Communication Manager, this must match the Near-end Listen Port defined on the Communication Manager signaling group in the previous sections.
• Trusted: Select Trusted. Note: If this box is not checked, calls from the associated SIP Entity specified in Section 6.5 will be denied.
• SIP Entity 3:

Click Commit to save. The following screens illustrate the entity links to Avaya Aura® Communication Manager. It should be noted that in a customer environment the entity link to Avaya Aura® Communication Manager would normally use TLS. For the compliance test, TCP was used to aid in troubleshooting since the signaling traffic would not be encrypted. The protocol and ports defined here must match the values used on the Avaya Aura® Communication Manager signaling group form in the previous sections

Entity Link to Avaya Aura® Communication Manager:

Entity Link to the DuVoice server:

Routing policies describe the conditions under which calls will be routed to the SIP Entities specified in the previous sections. Two routing policies must be added: one for Avaya Aura® Communication Manager and one for DuVoice. To add a routing policy, navigate to Routing>Routing Policies in the left-hand navigation pane and click on the New button in the right pane (not shown). The following screen is displayed. Fill in the following:

In the General section, enter the following values. Use default values for all remaining fields:

• Name: Enter a descriptive name.
• Notes: Add a brief description (optional).

In the SIP Entity as Destination section, click Select. The SIP Entity List page opens (not shown). Select the appropriate SIP entity to which this routing policy applies and click Select. The selected SIP entity displays on the Routing Policy Details page as shown below. Use default values for the remaining fields. Click Commit to save.

The following screens show the routing policy for Avaya Aura® Communication Manager.

The following screens show the routing policy for DuVoice.

Dial Patterns are needed to route calls through Avaya Aura® Session Manager. For the compliance test, dial patterns were needed to route calls from Avaya Aura® Communication Manager to DuVoice and vice versa. Dial Patterns define which route policy will be selected for a particular call based on the dialed digits, destination domain and originating location. To add a dial pattern, navigate to Routing>Dial Patterns in the left-hand navigation pane and click on the New button in the right pane (not shown). Fill in the following, as shown in the screens below:

In the General section, enter the following values. Use default values for all remaining fields:

• Pattern: Enter a dial string that will be matched against the Request-URI of the call.
• Min: Enter a minimum length used in the match criteria.
• Max: Enter a maximum length used in the match criteria.
• SIP Domain: Enter the destination domain used in the match criteria.
• Notes: Add a brief description (optional).

In the Originating Locations and Routing Policies section, click Add. From the Originating Locations and Routing Policy List that appears (not shown), select the appropriate originating location for use in the match criteria. Lastly, select the routing policy from the list that will be used to route calls that match the specified criteria. Click Select.

Default values can be used for the remaining fields. Click Commit to save.

Examples of the dial patterns used for the compliance testing are shown below. The first example shows dial pattern 3310 for the voice mail hunt group which routes the calls to DuVoice, have a SIP Domain of all, an originating location name of Lab-HG Location, and uses routing policy name To DuVoice.

The following dial pattern example used for the compliance testing uses dial pattern 304, these are the first 3 digits of the four digit extensions numbers assigned to the stations. Have a SIP Domain of avaya.lab.com, an originating Location name of DuVoice, and a routing policy name of SIP inbound calls to Lab-HG CM.

Note: Only 4 digits extension numbers assigned to stations were used for the compliance testing (e.g., 3040, 3041, etc.)

The creation of an Avaya Aura® Session Manager element provides the linkage between Avaya Aura® System Manager and Avaya Aura® Session Manager. This was most likely done as part of the initial Avaya Aura® Session Manager installation. To add an Avaya Aura® Session Manager, navigate to Elements>Session Manager>Session Manager Administration in the left-hand navigation pane and click on the New button in the right pane (not shown). If the Avaya Aura® Session Manager already exists, click View (not shown) to view the configuration. Enter/verify the data as described below and shown in the following screen:

In the General section, enter the following values:

• SIP Entity Name: Select the SIP Entity created for Session Manager.
• Description: Add a brief description (optional).
• Management Access Point Host Name/IP: Enter the IP address of the Session Manager management interface.

In the Security Module section, enter the following values:

• SIP Entity IP Address: Should be filled in automatically based on the SIP Entity Name. Otherwise, enter IP address of Session Manager signaling interface.
• Network Mask: Enter the network mask corresponding to the IP address of Session Manager.
• Default Gateway: Enter the IP address of the default gateway for Session Manager.

Use default values for the remaining fields. Click Save (not shown) to add this Avaya Aura® Session Manager. The screen below shows the Avaya Aura® Session Manager values used for the compliance test.

The screen below shows the Avaya Aura® Session Manager values used for the compliance test.

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.

Before installing the DuVoice DV2000 software, complete the following preparatory steps:

• Verify your system meets or exceeds the system requirements, for both the hardware and the OS.
• Install the Dialogic driver software.
• Ensure your system is connected to the Internet for license activation. If you do not want the system connected to the Internet all the time, you can disconnect it after the installation process is complete. If connecting to the Internet is not possible, contact your sales or support representative to get a license file, if one has not already been supplied to you. Once you have the license file, copy it to folder on the system, such as C:\OEM.
• Download the latest version of the DuVoice DV2000 software and copy it to a temporary folder on the system, such as C:\TEMP.
• Internet access via port 80 may be required to download additional licenses and activate the system. If internet access is not available or is blocked and additional languages are needed please use the Full Install. Activation can also be performed via activate.duvoice.com.

Once your system is prepared for installation, run the DV2000 installer on the system from the folder where you copied it. By default, the installer executable is named after its version number. For example, the installer for 6.02.16 is named dv-66216.exe. Then follow the instructions contained in the install wizard, as described below.

1. First, the installer will attempt to download the license file over the Internet. If successful, it will proceed to the next step. If it cannot download the file, it will prompt you to perform a manual activation, which is described in the Manual Activation section below.

2. The first page of the install wizard is informational only. Click Next to continue.

3. Next, read the license agreement and, if you accept it, click I Agree. You cannot continue with installation unless you agree to the terms of the license.

4. Select the components to install. Then click Next to continue.

Components include:

Once installed, a language must be activated in System Configuration before it can be used. You can only activate and use as many languages as your license allows.

Note: Several of the language prompt sets are guest-only and cannot be used as the default language because they only provide a limited subset of the system prompts.|

5. Choose the data location. As described on the page, this will be where all voice messages, custom prompt recordings, and any other information associated with the site will be stored. The default is C:\VS. Click Install to continue.

6. For new installations system will request your license information. If this is a kit you would have received an activation code. If you did Click Yes.

This procedure requires port 80 and access to the DuVoice activation site activate.duvoice.com. If the system doesn't have internet access, you can activate and download your license from activate.duvoice.com. When internet access is blocked Activate will ask if you have a file to install which you can always download from activate.duvoice.com.

7. If this is an upgrade or update and the system has an existing license, Click Yes. If you were given a license file Click No and select the license file.

8. Enter your license number.

9. The install will begin, displaying the page below.

7. If needed, the installer will install the Microsoft redistribution required by DV2000 software and may open other windows as part of the install process (closing them automatically when it is finished).

If this was a clean install (not an upgrade install), the system will automatically launch the Setup wizard so you can complete the basic setup configuration. Otherwise, it will simply start up the Activity Monitor application.

If step 1 above fails because the installer could not connect to the license server over the Internet, it will prompt you to perform activation manually. The install cannot proceed until the license information is installed on the system.

If you have a license file, place it in a folder on the DV2000 system's hard drive (such as in C:\OEM) and then click Yes. The system will open the normal Windows File Open dialog, which you can use to navigate to the folder where you saved the license file. Select the file and click OK. The system will then verify and load the file and proceed with the install at step 2 above.

If you do not have a license file, click No. The system will ask if you know your license number. If you do, you can click Yes, enter the number in the box provided, and click OK. The system will then try to contact the license server again, but if there is no connection to the Internet, this attempt will also fail. The installer will display a message that your system is not licensed for this product and will then halt. You will need to connect the system to the Internet so that it can perform the activation automatically, or else contact your sales or support representative to request a license file for your system.

To get a license file for manual activation you will need the following:

• Your system's license number
• Your system's network MAC address

If you purchased a turn-key DuVoice system, you will find the license number printed on a sticker that should be attached to the machine near the Windows sticker (typically, on the side). If your installation is from a software kit and you provided your own hardware, the sticker should have been included in the software kit materials. It will look similar to the figure below:

The MAC address can be acquired by opening a command window and typing ipconfig /all at the prompt. The figure below shows an example:

The line you are looking for is the one labeled Physical Address for the Ethernet adapter. The MAC address will be set of six two-digit hexadecimal numbers displayed in form: 00-00-00-00-00-00. Instead of all zeros it will have a mix of digits from 0-9 and letters A-F. In the figure above, this is the line that has been obscured.

Provide both pieces of information to the sales or support representative and he or she will be able to have a proper license file generated which can then be emailed to you. Once you have this file, follow the steps in the section above to install the software.

Once the install has finished, it will automatically run the Setup wizard to guide you through basic system configuration. This section shows the step-by-step process for a SIP-enabled system.

The first page is informational only, listing what information you will need to complete the setup process. When you are ready to proceed, click Next.

On the Site Information page, you must, at a minimum, enter the site name and a site phone number. Dealer name, phone number, and address may optionally be entered as well. When finished, click Next to continue.

Create an initial administrator account. Optionally also create a standard user account for accessing InnDesk or other web based interfaces. This option can be skipped, if necessary and completed within System Configuration. For additional security some words cannot be used for account names. When finished, click Next to continue.

On the Tenant Information page, enter the extension or hunt group number for the operator; the default is 0. If you would like the operator to have a mailbox for receiving messages, check the box provided. When finished, click Next to continue.

On the PBX Model page, select the PBX integration to use. If your model is not listed, you can just select Other | SIP Enabled PBX for now. The PBX model can be changed later in System Configuration if necessary. Select a PBX and then click Next to continue.

On the MWI Method page, select the method or protocol to use when sending MWI codes to the PBX. If you selected a PBX on the previous page for which the available methods are known, only those methods will be selectable and the others will be disabled. However, if you selected Other | SIP Enabled PBX (as in the example above), all options will be available and it is left to you to know the correct choice for your PBX.

If you select Inband using a feature or shortcode, use the Set code and Clear code boxes to enter the required codes. As noted on the page, you should enter an E in the correct position in the code where the extension number should be dialed; if you don't, the extension will always be appended to the end.

Click Next to continue when you are finished.

On the SIP Information page, enter the IP address or DNS name for the PBX in the box provided. Click Next to continue.

On the Voice Ports page, enter the extension number for each port. This is required for some PBX integrations, but if you don't know the port extension numbers yet you can leave them blank and add them later using System Configuration.

If the extension numbers are in numeric order starting at port 1, you can just enter the extension for port 1 and then check the Auto increment extension numbers based on line 1 box and the wizard will auto-generate the remaining port extensions (they will be displayed on the next page for your review). You may also enter a voicemail hunt group number in the box provided.

Click Next to continue.

The final page summarizes your selections so you can review and confirm them. If you need to change something, click Back. You can keep clicking Back until you get to the page you want to edit. Otherwise, click Finish to save the configuration and close the wizard.

The DuVoice DV2000 can link to an Avaya ACM PBX using a TCP connection where the ACM is the client. This link uses the protocol and features listed in the table below:

For instructions on configuring the ACM itself, refer to the How To entry for Passing PMS Data to the ACM, specifically the section Configure the ACM.

This page is used to configure the DV2000's link to the ACM.

The settings are grouped into two categories: Network and Overrides. Configure the settings as needed and then click OK to save your changes and close the dialog. Or click Cancel to discard any changes and close the dialog.

By default, this should be enabled so that the PBX can be properly updated when necessary. If the swap process is generating errors on the PBX that cause the PBX to drop the link, this setting can temporarily be disabled until the issue can be resolved.|

If your PBX is configured for 7 digit extensions, then enable this setting so the voice server can process the protocol messages correctly.|

By default, this setting is automatically set to enabled when you select the PBX link type as ACM because the ACM protocol uses checksums.|

By default, this setting is automatically configured to enabled when you select the PBX link type as ACM because the ACM protocol uses ENQ to query if the voice server is ready to receive and therefore expects an ACK response.|

This value depends on how you configured the Seconds before PMS Link Idle Timeout setting on the ACM. By default, it is set to 20 seconds. The polling interval needs to be set to a value less than that to ensure a timeout is not triggered on the PBX. It is recommended to set it at least 3-5 seconds less than the PBX value.|

The default is 500 ms (half a second). If the PBX is getting overwhelmed, you can increase this value to artificially slow the pace of message traffic.|

• Create a guest mailbox. See mailbox creation.