FAQ: Avaya Aura Basic Development Environment

This topic provides answers to frequently asked questions about the capabilities, configuration and use of the Avaya Aura Basic Development Environment (Avaya Aura BDE) for unit testing and debugging applications that are being developed against the Avaya Aura Application Enablement Services APIs.

Important: Avaya Aura BDE has gone End-of-Sale and is no longer available to new customers. DevConnect has also announced End-of-Sale plans for license renewals, effective 31 January 2017. Details of this EoS announcement can be found here. After 31 Jan 2017, neither new installations of BDE or renewed license keys will be available. The legacy documentation documentation is accessible here.

As an alternative to Avaya Aura BDE, DevConnect Technology Partners and Test-enabled members may purchase Avaya Aura Full Stack for VMware with Avaya Aura Media Server for use in their labs.

Avaya Aura BDE

Which releases of Communication Manager and AE Services are provided with Avaya Aura BDE?

Currently, Communication Manager Release 6.0.1 and Application Enablement Services Release 6.1 are delivered with Avaya Aura BDE.

Is Communication Manager SNMP alarming supported?

Communication Manager SNMP alarming support is enabled in Avaya Aura BDE.

Can I access and modify the load generator/scripting provided in DADS?

End user modification of the load generator and scripting is not accessible by users of Avaya Aura BDE. If you wish to monitor extensions that are involved in the scripted call handling, their extension ranges are 601001- 601072 and 7001001-700148

I want to continue using an older version of Avaya Aura BDE. How can I do it?

Presently Avaya is not supporting old versions (prior versions) of Avaya Aura BDE. While Avaya acknowledges that some application developers are not necessarily prepared to move to the newer release of Communication Manager and AE Services, we do not have sufficient resources assigned to Avaya Aura BDE to maintain multiple release streams and the licensing for them.

How do I migrate from a previous version of Avaya Aura BDE to a newer version?

Migration of the configured information for Communication Manager and AE Services is supported. The instructions for doing so are included with the DVD as a pdf document emailed to the member purchasing an upgrade. You need to take action before performing the upgrade.

Are additional licenses needed?

Avaya has attempted to include licensing for as many possible features and capabilities with the simulator. Due to license agreements with other vendors, the TSAPI SDK must be sold as a separate item. The licenses to use TSAPI are included with Avaya Aura BDE.

How do I shutdown Communication Manager and AE Services?

When logged in as "craft", you can use:

>>>sudo /sbin/shutdown -h now
>>>poweroff
							

Why aren't changes to the configuration (provisioned data) saved from one invocation of Avaya Aura BDE to the next?

The VMware Player does not save the Linux machine image changes from one invocation to the next. An observable manifestation of this behavior is that provisioning changes to either Communication Manager or AE Services are not "saved". The same is true for any log files that the systems generate. VMware Workstation does not have this limitation.

How can I view license information for AE Services?

You can view the configured license information by logging to a Linux prompt at AE Services as "craft" with an appropriate password (default is "craft01") and looking at the license file itself which is stored in:

/usr/share/tomcat-5.0.28/webapps/WebLM/licenses/xxxxxxxxx.xml
							
The tomcat-5.0.28 directory will vary by the release of AE Services in use. The name of the XML file itself may vary slightly from one release to the next.

Alternatively WebLM can be accessed through the AE Services OA&M interface (log in as "admin" with an appropriate password) then click on "Application_enablement" and the configured license information can be observed. This method has the benefit of allowing license USE to be observed as well.

Why am I receiving a response "Security DataBase is turned off, No List will be returned" when sending CallCenterProvider.getACDAddress() method of JTAPI with Avaya Aura BDE?

The Security Database (SDB) of the AE Services in the Avaya Aura BDE is disabled via the OA&M interface for ease of use for most operations. Certain operations require the SDB to be enabled. Please consult the Application Enablement Services Administration and Maintenance for guidance in configuring the SDB and enabling it in order to proceed with the use of this method.

Why does an install of Avaya Aura BDE (by running setup.exe from the DVD), after password input, the setup stops with the following message box: "This Application requires a VMware Product (ESX, GSX, Workstation or Player)"?

To install Avaya Aura BDE, you need VMware Workstation 7.0 (approximate $170 and the recommended solution), VMware Server or another VMware product. If you have the VMware installed and if you are still getting this error, please check the location where it is installed. The simulator expects VMware to be in the Program Files directory on your machine. The simulator installer only looks at c:\Program Files\VMware so modifying the default location will cause the installation to fail. Note that the use of VMware player does not allow the customer to save provisioning changes to Communication Manager or AE Services, which is severally limiting.

Is it possible to use ACD features such as having agents log in/off using the IP Phones type (9620) in Avaya Aura BDE?

Yes. There is a large pool of agents administered, you can log in stations to these agents (x50001-~x50200), you can utilize the DADS Simulator's DCP virtual phones and go off hook and dial the login/out feature access codes (*88/*89 respectively), or use abbreviated dial buttons. There is also a pool that is automatically logged in using agent IDs x610001-610048 and x7100001-7100032) as DADS (CM) starts up. Alternately, you can change the network configuration to allow access to a private or corporate LAN and use 'real' IP hard phones or IP Soft phones to register against the simulator and then login/out.

How do I perform provisioning with Avaya Aura BDE Communication Manager?

The simplest way to log in is to use the Linux console and type the command 'sat' then login with the credentials provided in the documentation and choose terminal type 'w2ktt'. Alternatively, telnet to 192.168.17.129:5023 (MS Windows DOS command is 'telnet 192.168.17.129 5023') and login with the same credentials and terminal type as above. Alternatively set your browser's URL to "http://192.168.17.129", login with appropriate credentials and select the administration link.

When using the w2ktt terminal type (the only one I recommend trying to use unless you use ASA or the Web based provisioning interface) the following command sequences are recognized:

  Tab -- next field 
  Arrow keys --- navigate in form 
  Esc-h -- help; both on the command line and field sensitive in a form 
  Esc-x - cancel; both on the command line and in a form. 
  Esc-e - enter/submit a form (with changes in it) 
  Esc-n -- next page 
  Esc-p -- previous page 
  Esc-r -- redraw the current form
  							

How do I configure the security database (SDB) on AE Services?

Please consult the Application Enablement Services Administration and Maintenance documentation bundled with the Avaya Aura BDE installation in the Documentation/AE Services directory.

What is the maximum number of stations that Avaya Aura BDE supports?

Within Avaya Aura BDE, AE Services supports a maximum of 2400 stations for administration and provisioning purposes. This information can be found by running the 'display system-parameters customer-options' command on Communication Manager's SAT terminal. On the first page, the field 'Maximum Stations' shows the maximum number of stations allowed in the system. Values for other system maximum provisioned limits and the provisioned features can be accessed using this command. For example the maximum IP trunks and maximum concurrently registered IP Stations can also be found on 'IP Port capacities' page of this command.

Why does my application receive a ConnectionCleared immediately when using third party call control services (e.g. makeCall) with DMCC, JTAPI or TSAPI and the DADS DCP emulated extensions?

The DADs emulated station must have an open window when using third party call control services on these extensions so the station can 'react' to the off-hook request that is sent from Communication Manager for call originating services. If the DADs console window for the extension is not running (it can be minimized, but it must exist), then the DADs virtual fabric manager, responds to the off-hook request, with an on-hook indication and the call is cleared. To open a window for an extension, launch the DADs Console, and then click on Phone > 8434; enter the extension of the phone you need to work with, leave the "PN Number" blank and click OK.

Can we load Avaya Aura BDE on a Linux based OS?

Use of Avaya Aura BDE on Linux platforms is not a supported configuration. While some members report using it successfully, Avaya DevConnect cannot help troubleshoot issues from its use on a Linux server.

The only way to use virtual machines in a Linux environment is to install the simulator on a Windows machine, copy the virtual machine images to the Linux platform and run them from the Linux platform. There is no Linux installer for the simulator.

In order to activate the licensing, you will need to change the configuration to a private or corporate LAN configuration and run the DADs console from the Windows platform.

The DevConnect portal topic for Avaya Aura BDE specifies the supported operating systems.

Why don't I hear call progress tones from Avaya Aura BDE?

Call progress tones are not available since they are not supported by Avaya Aura BDE. Avaya Aura BDE does not have any media processing resources implemented in it. Communication Manager uses hardware resources for tone detection, tone generation, media conversion (TDM/IP), and conferencing. Avaya Aura BDE does not have software solutions for these services. For more details please refer to the Avaya Aura BDE topic on the DevConnect Web portal.

How can I provision a loopback IP trunk on Communication Manager?

The following steps describe a loopback IP trunk set up for the Avaya IP Communications Development Environment Release 4.00.0005. These procedures should work on any release of Communication Manager supporting H.323 IP Trunking up through Release 5.2.

Step 1
Create a new node-name 'loopback' with the same IP address as listed against procr node using the 'change node-names ip' System Access Terminal (SAT) command.

change node-names ip		Page   1 of   2 

IP NODE NAMES
Name                IP Address
canary              135.9.131.151                          
default             0.0.0.0                                
grouse              135.9.85.188                           
kingfisher          135.9.131.189                          
krispy              135.9.86.152                           
loopback            10.10.13.190                           
procr               10.10.13.190                           
prowler1            127.0.0.2                              
prowler2            127.0.0.3                              
raven               135.9.86.54                            
scully              135.9.88.79                            
sessim              192.168.17.130                         
stork               135.9.86.29                            
tuttle              135.9.88.62                            
vanilla             135.9.131.14                           
zours               135.9.86.226                           
( 16 of 16   administered node-names were displayed )
Use 'list node-names' command to see all the administered node-names
Use 'change node-names ip xxx' to change a node-name 'xxx' or add a node-name
							

Step 2
Create a new signaling group using the SAT command 'add signaling-group NN', where NN is an integer signaling group identifier which is not used currently on the system. A list of signaling group identifiers in use can be retrieved using the SAT command 'list signaling-group':

list signaling-group                                                            

                                SIGNALING GROUPS

Grp  Group         No.        Primary    Secondary  Max       Max      No. Adm'd
No.  Type     FAS? Trunk Brds D-Channel  D-Channel  NCA TSCs  CA TSCs  NCA TSCs

1    sip      y    1                                0         0        0 

							
In this set up, signaling group identifier 10 is used.


Step 3
On the 'add signaling-group NN' form, change the 'Group Type' field value to be h.323 on page 1. Note, that Trunk Group for Channel Selection field cannot be filled in at this point. The field 'Near-end Node Name' has to be set to procr and Far-end Node Name value needs to be set to loopback. The field 'Far-end Listen Port' has to be set to the same value as Near-end Listen Port:

add signaling-group 10                                          Page   1 of   5 
                                SIGNALING GROUP

 Group Number: 10             Group Type: h.323   
                           Remote Office? n          Max number of NCA TSC: 0  
                                     SBS? n           Max number of CA TSC: 0  
          IP Video? n                              Trunk Group for NCA TSC:     
       Trunk Group for Channel Selection:                                       
      TSC Supplementary Service Protocol: a          Network Call Transfer? n
                         T303 Timer(sec): 10

   Near-end Node Name: procr                 Far-end Node Name: loopback       
 Near-end Listen Port: 1720                Far-end Listen Port: 1720 
                                        Far-end Network Region:    
         LRQ Required? n                 Calls Share IP Signaling Connection? n
         RRQ Required? n
     Media Encryption? n                     Bypass If IP Threshold Exceeded? n
                                                      H.235 Annex H Required? n
         DTMF over IP: out-of-band            Direct IP-IP Audio Connections? y
  Link Loss Delay Timer(sec): 90                        IP Audio Hairpinning? n
         Enable Layer 3 Test? n                  Interworking Message: PROGress
 H.323 Outgoing Direct Media? n          DCP/Analog Bearer Capability: 3.1kHz

							


Step 4
Create a new trunk group using the SAT command 'add trunk-group KK', where KK is an integer trunk group identifier not used currently on the system. A list of trunk group identifiers can be retrieved using the SAT command 'list trunk-group':

list trunk-group                                                                
                                TRUNK GROUPS
Grp                                                 No.                  Out Que
No.  TAC  Group Type    Group Name                  Mem TN  COR CDR Meas Dsp Len

1    201  tie           OUTSIDE CALL                48  1   1   y   both n   0  
2    202  tie           OUTSIDE CALL                48  1   1   y   both n   0  
3    203  tie           OUTSIDE CALL                48  1   1   y   both n   0  
4    204  tie           OUTSIDE CALL                48  1   1   y   both n   0  
5    105  sip           SIP trunk to SES            5   1   1   y   none n   0  

							
In this set up, trunk group identifier 10 is used.


Step 5
On page 1 of the SAT command ''add trunk-group 10' configure the following items:

  • The field 'Group Type' has to be set to isdn.
  • The Group Name field should be changed to loopback.
  • The field TAC has to be set to 210
  • The field 'Carrier Medium' has to be set to H.323.
  • The field 'Service Type' has to be set to tie.
  • The field Member Assignment Method has to be set to auto.
  • The field 'Signaling Group' has to be set to 10 - which corresponds to the signaling group identifier used on Step 3
  • Set the field 'Number of Members' to 4. Since the Avaya Aura Basic Development Environment (BDE) has a limited number of IP trunks a maximum of 4 trunk members is used which allows two simultaneous loopback trunk calls.

add trunk-group 10                                              Page   1 of  21 
                                TRUNK GROUP

Group Number: 10                   Group Type: isdn          CDR Reports: y
  Group Name: loopback                    COR: 1        TN: 1        TAC: 210 
   Direction: two-way        Outgoing Display? n         Carrier Medium: H.323  
 Dial Access? n              Busy Threshold: 255  Night Service:              
Queue Length: 0                                                               
Service Type: tie                   Auth Code? n                              
                                              Member Assignment Method: auto  
                                                       Signaling Group: 10 
                                                     Number of Members: 4  
							
On page 3 the fields 'Send Name', 'Send Calling Number' and 'Send UCID' should be set to y.

add trunk-group 10                                              Page   3 of  21 
TRUNK FEATURES
          ACA Assignment? n            Measured: none    
                                 Internal Alert? n        Maintenance Tests? y
                               Data Restriction? n     NCA-TSC Trunk Member:    
                                      Send Name: y      Send Calling Number: y
            Used for DCS? n                            Send EMU Visitor CPN? n
   Suppress # Outpulsing? n
                                             UUI IE Treatment: service-provider

                                                 Replace Restricted Numbers? n
                                                Replace Unavailable Numbers? n
                                                      Send Connected Number: n
Network Call Redirection: none                    Hold/Unhold Notifications? n
             Send UUI IE? y
               Send UCID? y
 Send Codeset 6/7 LAI IE? y
							

Step 6
Change AAR analysis for extensions starting with 2 by modifying corresponding line on the page 1 of the 'change aar analysis 2' SAT command, where 'Total Min' and 'Total Max' values define number length and 'Route Pattern' has to be set to a route-pattern which specifies the trunk group identifier defined on step 5. This route pattern is configured in a subsequent step or this procedure.

change aar analysis 2                                           Page   1 of   2 
                             AAR DIGIT ANALYSIS TABLE
                                   Location:  all           Percent Full:    1  

          Dialed           Total     Route    Call   Node  ANI
          String          Min  Max  Pattern   Type   Num   Reqd
    2                     10   10    10       aar          n
    3                     5    5     5        aar          n
    3                     7    7     254      aar          n
    4                     7    7     254      aar          n
    5                     7    7     254      aar          n
    6                     7    7     254      aar          n
    7                     7    7     254      aar          n
    8                     7    7     254      aar          n
    9                     7    7     254      aar          n

							

Step 7
Create a route pattern for the trunk group identifier defined on step 5 using the SAT command 'change route PP', where PP is an integer identifier of the route pattern. In this configuration, route pattern identifier 10 is used. In this route pattern we are sending the call through trunk group 10, and deleting the first 5 of the 10 digits that were dialed to reach the route through AAR.

change route-pattern 10                                         Page   1 of   3 
                    Pattern Number: 10  Pattern Name:                
                             SCCAN? n     Secure SIP? n
    Grp FRL NPA Pfx Hop Toll No.  Inserted                             DCS/ IXC
    No          Mrk Lmt List Del  Digits                               QSIG
                             Dgts                                      Intw
 1: 10   0                    5                                         n   user
 2:                                                                     n   user
 3:                                                                     n   user
 4:                                                                     n   user
 5:                                                                     n   user
 6:                                                                     n   user

     BCC VALUE  TSC CA-TSC    ITC BCIE Service/Feature PARM  No. Numbering LAR
    0 1 2 M 4 W     Request                                 Dgts Format
                                                         Subaddress
 1: y y y y y n  n            rest                                         none
 2: y y y y y n  n            rest                                         none
 3: y y y y y n  n            rest                                         none
 4: y y y y y n  n            rest                                         none
 5: y y y y y n  n            rest                                         none
 6: y y y y y n  n            rest                                         none

							

Step 8
Using the SAT command 'change public-unknown-numbering 5', change the Public/Unknown numbering format for 5 digit extensions starting with 32. This allows all originations from Avaya Aura BDE extensions 32xxx to appear with a 10 digit calling party number (ANI) of 333 123 2xxx when terminating through the loopback trunk.

change public-unknown-numbering 5                               Page   1 of   2 
                      NUMBERING - PUBLIC/UNKNOWN FORMAT
                                           Total
Ext Ext           Trk       CPN             CPN
Len Code          Grp(s)    Prefix          Len
                                                     Total Administered: 2    
 5  32            10        33312           10          Maximum Entries: 9999 
 5  33            5         73285           10
							

Step 9
Using 'change signaling-group 10' SAT command , set the 'Trunk Group for Channel Selection' value to the trunk group identifier defined on step 5 (i.e. 10) for the signaling group (i.e 10) defined on step 3.

change signaling-group 10                                       Page   1 of   5 
                                SIGNALING GROUP

 Group Number: 10             Group Type: h.323   
                           Remote Office? n          Max number of NCA TSC: 0  
                                     SBS? n           Max number of CA TSC: 0  
          IP Video? n                              Trunk Group for NCA TSC:     
       Trunk Group for Channel Selection: 10  
      TSC Supplementary Service Protocol: a          Network Call Transfer? n
                         T303 Timer(sec): 10

   Near-end Node Name: procr                 Far-end Node Name: loopback       
 Near-end Listen Port: 1720                Far-end Listen Port: 1720 
                                        Far-end Network Region:    
         LRQ Required? n                 Calls Share IP Signaling Connection? n
         RRQ Required? n
     Media Encryption? n                     Bypass If IP Threshold Exceeded? n
                                                      H.235 Annex H Required? n
         DTMF over IP: out-of-band            Direct IP-IP Audio Connections? y
  Link Loss Delay Timer(sec): 90                        IP Audio Hairpinning? n
         Enable Layer 3 Test? n                  Interworking Message: PROGress
 H.323 Outgoing Direct Media? n          DCP/Analog Bearer Capability: 3.1kHz
							

Step 10
Check to see that the trunk is in-service by using SAT command 'status trunk 10'.

status trunk 10                                                                 

                             TRUNK GROUP STATUS

Member   Port     Service State      Mtce Connected Ports
                                     Busy

0010/001 T00006   in-service/idle    no                                      
0010/002 T00007   in-service/idle    no                                      
0010/003 T00008   in-service/idle    no                                      
0010/004 T00009   in-service/idle    no                                      
							

Step 11: Make a test call:
In IPCoDE/BDE the AAR access code is "8" - you can check this by looking at the 'change feature-access-codes' form page 1. Thus to use the configuration we have setup, we must dial a leading 8 (the way we have configured this - there is an alternate configuration using uniform dial plan that we have not taken advantage of whereby that requirement could be removed. I leave that as an exercise in learning about Communication Manager features for the interested reader). In step 6 we configured an AAR pattern that started with a digit 2 and was 10 digits long to route to the loopback trunk group we created. Thus if a call is placed to 8 222 2232130 it will be routed to routing pattern 10 where 5 leading digits will be removed (note the AAR access code of 8 was already removed by AAR the routing process), and a call placed through the trunk to 32130 which corresponds to an IPCoDE/BDE extension on the terminating side of the loopback trunk group. Thus using extension 32129 go off hook and dial 8 222 2232130. If 32130 is registered, the call should ring the destination station. In fact the second through fifth digit could be any digit 0-9, so 8 212 343 2130 would also ring 32130 as would 8 298 763 2130.

What supervisor user ID and password would enable a user to change the factory set configuration of Avaya Aura BDE?

The supervisor user ID ("root" and "init") and password for Avaya Aura BDE are confidential credentials and thus cannot be disclosed openly. If you need to have Avaya Aura BDE's licensed services modified, enter a DevConnect support request with the relevant details.

How can I procure Avaya Aura BDE?

Avaya Aura BDE is no longer available for sale. Members who need lab systems for development purposes are encouraged to purchase current Avaya Aura Stack offers from their Avaya account team, authorized Avaya channel partners, or as part of enhanced DevConnect membership benefits.

Why doesn't the DADS Console connect to Communication Manager?

By default the DADS Console shortcut on the desktop will launch the executable that connects to the Virtual Fabric Manager (VFM) running on the Avaya Aura BDE Communication Manager image. If the application cannot locate the vfmgui.ini file (it should be in the same directory as the vfmgui.exe executable), the executable will use a default IP address for the VFM (192.168.15.128).

If the configured IP address of Communication Manager is changed, then the default IP used by vfmgui.exe needs changed. The instructions for Avaya Aura BDE state that the vfmgui.ini file must be changed to accomplish this.

If after changing the vfmgui.ini file you then launch vfmgui.exe from the same directory that vfmgui.ini is in, then the DADS console (normally) connects. If the shortcut on the desktop continues to use the default IP address, the problem is most likely that the 'Start in:" property for the shortcut is not set.

One solution then is to right click on the DADS Console shortcut on the desktop, and set the "Start in:" property to "C:\Program Files (x86)\Avaya\Avaya Aura BDE\Tools"