avaya multivantage

8/13/2019 avaya multivantage

1/70

Avaya MultiVantage

Application Enablement ServicesInstallation Guide

Software-Only OfferR3.1.2

02-300355Issue 2.3

September 2006


2/70

2006 Avaya Inc.All Rights Reserved

Notice

While reasonable efforts were made to ensure that the information in thisdocument was complete and accurate at the time of printing, Avaya Inc. canassume no liability for any errors. Changes and corrections to the informationin this document may be incorporated in future releases.

For full support information, please see the complete document,Avaya Suppor t Not ices for Sof tware Documentat ion, document number03-600758.

To locate this document on our Web site, simply go to http://www.avaya.com/supportand search for the document number in the

search box.

Documentation disclaimer

Avaya Inc. is not responsible for any modifications, additions, or deletions tothe original published version of this documentation unless such modifications,additions, or deletions were performed by Avaya. Customer and/or End Useragree to indemnify and hold harmless Avaya, Avaya's agents, servants andemployees against all claims, lawsuits, demands and judgments arising out of,or in connection with, subsequent modifications, additions or deletions to thisdocumentation to the extent made by the Customer or End User.

Link disclaimer

Avaya Inc. is not responsible for the contents or reliability of any linked Websites referenced elsewhere within this documentation, and Avaya does notnecessarily endorse the products, services, or information described or offeredwithin them. We cannot guarantee that these links will work all of the time andwe have no control over the availability of the linked pages.

Warranty

Avaya Inc. provides a limited warranty on this product. Refer to your salesagreement to establish the terms of the limited warranty. In addition, Avayasstandard warranty language, as well as information regarding support for thisproduct, while under warranty, is available through the following Web site:http://www.avaya.com/support.

Copyright

Except where expressly stated otherwise, the Product is protected by copyrightand other laws respecting proprietary rights. Unauthorized reproduction,transfer, and or use can be a criminal, as well as a civil, offense under theapplicable law.

Avaya support

Avaya provides a telephone number for you to use to report problems or to askquestions about your product. The support telephone numberis 1-800-242-2121 in the United States. For additional support telephonenumbers, see the Avaya Web site: http://www.avaya.com/support.
http://www.avaya.com/supporthttp://www.avaya.com/supporthttp://www.avaya.com/supporthttp://www.avaya.com/support/http://www.avaya.com/support/http://www.avaya.com/supporthttp://www.avaya.com/supporthttp://www.avaya.com/support


3/70

Issue 2.3 September 2006 3

About this Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Intended audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Summary of information in this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Conventions used in this documentation set . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Application Enablement Services documents . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

CSTA References for AE Services programmers . . . . . . . . . . . . . . . . . . . . . . . 9

Related Communication Manager documents . . . . . . . . . . . . . . . . . . . . . . . . 10

Avaya security and toll fraud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Documentation feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 1: Prerequisites for AE Services . . . . . . . . . . . . . . . . . . . . . . . . 11

AE Services server hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Platform and third-party software required for AE Services server . . . . . . . . . . . . . . . . 12

Software platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Third-party software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Client application machine requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Communication Manager and media server requirements . . . . . . . . . . . . . . . . . . . . 15

Required network characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Network interface configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Supported network configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Network interface speed and duplex settings . . . . . . . . . . . . . . . . . . . . . . . . . 16

IP Migration Readiness and Optimization analysis . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 2: Installing the Linux platform software . . . . . . . . . . . . . . . . . . . . 17

Chapter 3: Installing the server software and third-party software . . . . . . . . . . 19

Obtaining the server software ISO image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Installing and configuring the server software . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Installing the ISO image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Running the AE Services installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Installed files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Locations of Installation/Upgrade logs and RPMs. . . . . . . . . . . . . . . . . . . . . . . . . 27

Uninstalling the AE Services RPMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Installation problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Contents


4/70

4 Application Enablement Services Installation Guide

Chapter 4: Installing licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Installing the Application Enablement Services license file . . . . . . . . . . . . . . . . . . . . 29

Troubleshooting the AE Services license installation . . . . . . . . . . . . . . . . . . . . . . . 31

If you receive error messages from WebLM . . . . . . . . . . . . . . . . . . . . . . . . . 31

If you do not have a license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Identifying the MAC address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 5: Initial administration for AE Services . . . . . . . . . . . . . . . . . . . . 33

Administering Communication Manager for AE Services . . . . . . . . . . . . . . . . . . . . . 33

Administering AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Where to go from here. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 6: Testing connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Running tests from the OAM pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Testing connectivity by running the sample application . . . . . . . . . . . . . . . . . . . . . . 38

Chapter 7: Upgrading and updating the AE Services software. . . . . . . . . . . . . 39

Upgrade considerations for RFA license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Upgrading the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Performing the upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Installing a new license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Updating the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Installing updates and patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Uninstalling updates and patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Uninstalling the AE Services software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Chapter 8: Security considerations and guidelines. . . . . . . . . . . . . . . . . . . 47

Appendix A: Running the sample application(Device, Media, and Call Control only) . . . . . . . . . . . . . . . . . . 49

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

The sample application files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Administer AE Services for the sample application . . . . . . . . . . . . . . . . . . . . . . . . 50

Administer Communication Manager for the sample application . . . . . . . . . . . . . . . . . 50

Administer a station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Administer network region/gateway configuration (if needed) . . . . . . . . . . . . . . . . 51

Edit the tutorial properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Running the sample application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Troubleshooting the sample application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53


5/70


Appendix B: Setting up for remote access(serial modem only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Setting up the Linux PC for remote access . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Installing the additional software components . . . . . . . . . . . . . . . . . . . . . . . . 56

Configuring the Linux PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Editing the inittab file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Editing the login.config file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Editing the pap-secrets file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Checking the PPP options file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Editing the options.tty file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Setting up the client to dial in to the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Windows clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Linux clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Connection Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Appendix C: Configuring an LDAP server for Common User Service utilization . . . 61

Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Configure the LDAP server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Create an LDAP User account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Appendix D: AE Services WAN requirements . . . . . . . . . . . . . . . . . . . . . . 65

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67


6/70



7/70


About this Book

Intended audience

Developers performing the installation of the Application Enablement Services server

software. These can be independent software vendors, enterprise application developers,

and Avaya partners.

Communication Manager administrators to administer Communication Manager for AE

Services, if necessary

Summary of information in this book

Prerequisites for running the AES server

Installing software on the AES server

Installing the AE Services license

Administering AE Services and Communication Manager for connectivity

Checking connectivity

Upgrading and updating AE Services servers

(For Device, Media, and Call Control only) Running a sample applicationThis book does not tell how to migrate from Avaya CT or CVLAN R9. That information is

provided in the administration and maintenance guide.

Note:

Note: AE Services provides some pre-existing Avaya application enablement APIs

(TSAPI, JTAPI, CVLAN, and Communication Manager API) For customers who

have previously used these APIs, they are often referred to by name. However,

Communication Manager APIis now named Device, Media, and Call Control.


8/70


Conventions used in this documentation set

The following typefaces are used in the AE Services documentation set:

Application Enablement Services documentsThese books comprise the Application Enablement Services document set (including this book):

Avaya MultiVantageApplication Enablement Services Overview(02-300360)

Avaya MultiVantageApplication Enablement Services InstallationGuide Software-Only

Offer (02-300355)

Avaya MultiVantageApplication Enablement Services Installation and Upgrade Guide for

a Bundled Server(02-300356)

Avaya MultiVantageApplication Enablement Services Administration and Maintenance

Guide (02-300357)

Avaya MultiVantageApplication Enablement Services Device, Media, and Call Control

Java Programmer Guide (02-300359)


Java Programmer Reference (Javadoc)

Matter Typeface and syntax Example

Commands This bold font for

literals

This bold italicfor

variables

1. Start your browser and type the appropriate URL

based on this example:

https://aeshostname:port/WebLM

where:

aeshostnameis your AE Services servers hostname

portis your AE Services servers port number(the default port number is 8443)

ASCIIoutput

ASCII output Wait for the Installation/Update completedmessage.

Filenames/pathnames

Normal font This choice configures an LDAP in the default location of/etc/openldap.

Field names Bold Select Install to proceed with the installation.


9/70

Related documents



XML Programmer Guide (02-300358)


XML Programmer Reference(XMLdoc)

Avaya MultiVantageApplication Enablement Services Web Services Programmers

Guide ((02-300362)

Avaya MultiVantageApplication Enablement Services Documentation Road Map

(02-300361)

Avaya MultiVantageApplication Enablement Services OAM Help(HTML)

Avaya MultiVantageApplication Enablement Services TSAPI Exerciser Help(.pdf)

Avaya MultiVantageApplication Enablement Services 3.1 TSAPI, JTAPI, and CVLAN

Client and SDK Installation Guide(02-300543)

Avaya MultiVantageApplication Enablement Services 3.1 TSAPI for Avaya

Communication Manager Programmer Reference(02-300545)

Avaya MultiVantage

Application Enablement Services 3.1 TSAPI Programmer Reference(02-300545)

Avaya MultiVantageApplication Enablement Services 3.1 CVLAN Programmer

Reference(02-300546)

Avaya MultiVantageApplication Enablement Services 3.1 ASAI Technical Reference

(03-300549)

Avaya MultiVantageApplication Enablement Services 3.1 ASAI Protocol Reference

(03-300550)

You can find all these documents online on the Avaya Support Centre Web Site

(http://www.avaya.com/support).

Related documents

CSTA References for AE Services programmers

For CSTA details not found in the programmers references or the programmers guides, see

the following CSTA documents. They are in the Publications section of the ECMA Web Site(http://www.ecma-international.org/):

ECMA-269: Services for Computer Supported Telecommunications Applications (CSTA)

Phase III
http://support.avaya.com/japple/css/japple?PAGE=avaya.css.ProductDetail&temp.groupID=107529&temp.selectedFamily=152705&temp.selectedProduct=158544http://www.ecma-international.org/http://www.ecma-international.org/http://www.ecma-international.org/http://support.avaya.com/japple/css/japple?PAGE=avaya.css.ProductDetail&temp.groupID=107529&temp.selectedFamily=152705&temp.selectedProduct=158544


10/70


ECMA-323: XML Protocol for Computer Supported Telecommunications Applications

(CSTA) Phase III

ECMA Technical Report TR/72: Glossary of Definitions and Terminology for Computer

Supported Telecommunications Applications (CSTA) Phase III

ECMA-354 Application Session Services

Related Communication Manager documents

The following books from the Communication Manager documentation set provide additional

information about administering Communication Manager for Application Enablement Services.

They are on the Avaya Support Centre Web Site (http://www.avaya.com/support).

Administrators Guide for Avaya Communication Manager (Issue 11 for CM 3.1),

03-300509)

Administration for Network Connectivity for Avaya Communication Manager (Issue 11 for

CM 3.1), 555-233-504_11)

Avaya security and toll fraud

For information about the secure configuration of your equipment and the mitigation of toll fraud

threats, see theAvaya Toll Fraud and Security Handbook555-025-600.

It can be found online at:

http://support.avaya.com/elmodocs2/comm_mgr/r3/pdfs/025600_10.pdf

Documentation feedback

Let us know what you like or do not like about this book. Although we cannot respond personally

to all your feedback, we promise we read each response we receive.

Please email feedback to [email protected]
http://support.avaya.com/japple/css/japple?PAGE=avaya.css.ProductDetail&temp.groupID=107529&temp.selectedFamily=152705&temp.selectedProduct=158544http://support.avaya.com/elmodocs2/comm_mgr/r3/pdfs/025600_10.pdfhttp://support.avaya.com/elmodocs2/comm_mgr/r3/pdfs/025600_10.pdfhttp://support.avaya.com/japple/css/japple?PAGE=avaya.css.ProductDetail&temp.groupID=107529&temp.selectedFamily=152705&temp.selectedProduct=158544


11/70


Chapter 1: Prerequisites for AE Services

This section explains the prerequisites for running Application Enablement Services. These

prerequisites include: AE Services server hardware requirements on page 11

Platform and third-party software required for AE Services serveron page 12

Client application machine requirements on page 14

Communication Manager and media server requirements on page 15

Required network characteristics on page 15

Before installing the AE Services software, make sure your system meets the following

hardware, software, and network requirements.

AE Services server hardware requirements

The AE Services server must be a 2.4-GHz or better single-processor Pentium IV class

machine with:

1GB RAM (required)

10 GB free disk space (after installing Linux)

Hard disk drive with at least 7200 rpm rating

512 KB L2 cache

100BaseT Ethernet NIC (should be set to full duplex)

Avaya strongly recommends two NICs.

CD-ROM drive

Note:

Note: The hostname of the AE Services server must be 15 characters or less. To

determine the hostname associated with an AE Services server, run the following

Linux command from the command line: uname n


12/70

Prerequisites for AE Services


Platform and third-party software required for AE Services

server

Software platform

Red Hat Enterprise Linux ES 3.0 (32-bit Standard Edition) Update 5

Note:

Note: Check the latest AE Services release notes for the latest update supported.

Third-party software

The following table shows the required third-party software packages. The table also tells which

services in AE Services requires this software package.

The AE Services installer installs and configures all of the required third-party packages. We

stronglyrecommend that you accept this option when installing the server software.

Table 1: Required third-party software

Name/Minimum Version Supported by AEServices

Required by

Apache Http Server 2.0.46 SMS

Apache mod_ssl 2.0.46 SMS

Note:

Note: Axis 1.1-13The Axis RPM

supplied by Avaya when you

install third-party software

using the installer is:

avaya-coreservices-axis 1.1

User Service, Telephony Web Service

Curl 7.10.6 PHP

Dialog 0.9b Installer

Ethereal 0.10.11 Avaya Services if you have a Servicescontract

1 of 3


13/70

Platform and third-party software required for AE Services server


gdb 6.3.0.0.0 (a debugger)

J2SDK 1.5 Device, Media, and Call Control, OAM

Kerberos (krb5) 1.2.7: krb5-devel, krb5-libs,krb5-workstation

TSAPI

Kerberos (pam_krb5) 1.75-1 TSAPI

libpcap 0.7.2 Ethereal

libxml2 2.5.10 SMS

net-snmp 5.0.9 Ethereal

net-snmp-libs 5.0.9 Ethereal

OpenLDAP 2.1.22 User Service

OpenLDAP clients 2.1.22 User Service

OpenLDAP servers 2.1.22 User Service

Openssl 0.9.7a SMS, Transport Layer

pdksh 5.2.14 DLG, Call Control

PHP 4.3.2 SMS

PHP Pear 4.3.2 SMS

PostgresSQL 7.3.10 TSAPI Service,

CVLAN, CMAPI, OAM

PostgresSQL-libs 7.3.10 TSAPI Service,

CVLAN, CMAPI, OAM

Table 1: Required third-party software (continued)


Required by

2 of 3


14/70



Note:

Note: There are numerous scripts in AE Services that use the perl package which is

part of the Red Hat ES 3.0 Linux distribution. The perl package is also available

for download also from http://www.perl.com.

You are responsible for your license agreements with companies of the third-party software.

Client application machine requirements

You must provide a client application machine for your AE Services system.

Device, Media, and Call Control applications can be developed and executed on any machine

that is capable of running the Java 2 Platform, Standard Edition (J2SE) 1.5 or later.

For the other AE Services clients, refer to theApplication Enablement Services 3.1 TSAPI,

JTAPI, and CVLAN Client and SDK Installation Guide.

PostgresSQL-server 7.3.10-1 TSAPI Service,

CVLAN, CMAPI, OAM

Tomcat 5.0.28 or later

Note:

Note: The Tomcat RPM supplied by

Avaya when you install

third-party software using the

installer is:

avaya-coreservices-tomcat 5.0.28

WebLM, OAM, User Service, Telephony WebService

Table 1: Required third-party software (continued)


Required by

3 of 3
http://localhost/var/www/apps/conversion/tmp/scratch_6//www.perl.comhttp://localhost/var/www/apps/conversion/tmp/scratch_6//www.perl.com


15/70

Communication Manager and media server requirements


Communication Manager and media server requirements

You must have the official Communication Manager R3.0/3.1 running on an IP-enabled media

server.

Note:

Note: Only Communication Manager 3.1 provides the Enhanced Link Bounce

Resiliency feature.

AE Services supports all media servers and gateways that support

Communication Manager 3.0/3.1.

Required network characteristics

Network interface configurations

With one exception, Avaya Services recommends that you configure AE Services to use dual

NICs (eth0 and eth1).

Single NIC

The application machine, AE Services server, and Communication Manager server reside

on a private LAN, virtual LAN (VLAN), or WAN.

Note:Note: The single NIC configuration is recommended for most S8300, S8400, and

S8500c servers that use a Processor Ethernet interface because the IP interface

for these servers must be publicly accessible for registration of IP endpoints.

Dual NIC (recommended)

In a dual NIC configuration, one interface is for the communication channel between the AE

Services server and the application, and the second interface is for the communication

channel between the AE Server and the Communication Manager CLAN.

- The application and the AE Server are on a LAN (production LAN or VLAN) or WAN.

- The AE Services server and the Communication Manager CLAN interfaces are on a

private LAN or VLAN.


16/70



Supported network configurations

Regardless of whether a LAN, VLAN or WAN is used, The TCP/IP links between the AE

Services server and Avaya Communication Manager can be connected with the following

network latency requirements:

No more than a 200ms average round trip packet delivery time as measured with ping over

every one-hour time period

Periodic spiked delays of no more than two seconds while maintaining the 200ms average

round trip delivery time as measured with ping over every one-hour time period

These requirements are to maintain the AE Services communication channel with CM (CLANs)

over a LAN/VLAN or WAN.

Network interface speed and duplex settings

AE Services has been tested at 100BaseT full duplex, and these are the required speed and

duplex mode settings. The NIC settings should be verified before installing AE Services.

IP Migration Readiness and Optimization analysis

We also recommend that you use the Avaya IP Migration Readiness and Optimization services

to help you safely implement IP-based solutions in a stable, optimized infrastructure.

These services include a two-phased, detailed analysis of the entire network to help assess

whether you can deploy a converged IP solution such as AE Services without adverselyaffecting your existing network applications and services.

The first phase of this analysis is the Customer Infrastructure Readiness Survey (CIRS).

Certified Avaya engineers conduct a high-level evaluation of the local and wide area network

infrastructure to identify any significant network issues that must be resolved prior to deploying

the proposed IP solution.

Phase 2 of this analysis, Network Analysis/Network Optimization (NANO) is required when the

CIRS indicates that the network will not support the proposed IP solution at the desired

performance levels. Starting with the information and data gathered for the CIRS, Avaya

engineers perform problem diagnosis to get at the root causes of network issues. They also

provide functional requirements and recommendations for a network design that optimizes all of

the resources needed to support the IP solution.


17/70


Chapter 2: Installing the Linux platform software

You must obtain and install the Linux platform software. Avaya does not provide a Linux RPM or

a Linux installation script. You must install Linux before you install the Application EnablementServices server software because the installation script also configures Linux for AE Services.

To install Redhat Enterprise Linux ES 3.0 update 5:

1. Follow the instructions of the Red Hat installation utility to install your system.

2. Follow these additional guidelines we provide for installation:

Select the minimum install for Linux. Performing a complete install may result in versionconflicts with some of the third-party software packages required by AE Services.

For security reasons, you should enable only a specific list of ports on the server firewall.

This list includes all of the ports that the AE Services software uses. For a list of these

ports, see the White-paper on Security in Application Enablement Services for Bundled

and Software only solutions.

Use the Linux default partitioning.

3. Complete the Linux installation and reboot the system.

4. To the /etc/hosts file, add a separate line that specifies the IP address of the AES server.

For example:

127.0.0.1 localhost

135.9.30.106 dr-dfla0 dr-dfla0.dr.avaya.com

Under some circumstances, Apache httpd may need this line. If this file contains an

incorrect address, AE Services will not start.


18/70

Installing the Linux platform software



19/70


Chapter 3: Installing the server software and

third-party software

This chapter explains how to install all of the AE Services software on the AES server machine.

The installation script also optionally performs these recommended tasks:

Configures Linux

Installs the third-party software packages required by AES

Configures the third-party software packages for AE Services.

We recommend that you select these options in the installation script.

Obtaining the server software ISO image

Obtain the server ISO image from one of these sources:

The AE Services CD-ROM that was shipped to you

The Avaya DevConnect site

Installing and configuring the server software

Installing the ISO image

To install from the ISO image, you can either:

Create a CD-ROM from the ISO image and install from the CD-ROM

or

Download and mount the ISO image and install from the mounted image

You must Install the server software from a window that emulates xterm or is recognized by

Linux. If you install the software from a DOS window, you may have display problems.


20/70

Installing the server software and third-party software


Perform these steps:

1. Log in as a user with root privileges.

2. Mount the drive or the image:

Insert the CD-ROM into the CD-ROM drive and mount the drive:

mount /mnt/cdrom

or

Download the ISO image to the /tmp directory of the AE Services server and mount the

image as a CD-ROM:

mount -t iso9660 -o loop /tmp/xxxx.iso /mnt/cdrom

where xxxx= is the name of the ISO image.

3. If AE Services is installed, stop the mvap, DBService, and tomcat5 services.

4. Run the installer script (it may run automatically).

/mnt/cdrom/install

The installer script starts.

Running the AE Services installer

The startup screen provides a guide for navigating through the dialog boxes.


21/70



To proceed with the installation:

1. Press Enterto continue.

The Loss of Data Warning screen appears:

If you are upgrading from a previous release and have notbacked up your database,

a. Select Noto quit this installation

b. Back up your database.

c. Restart the installer.

SelectYesif you do not need to back up a database (either you arent upgrading or youalready backed up the database.

The Select Installation Media screen appears.

Note:

Note: The rest of these installation instructions assume that you will know when to

select OKand press Enterto continue.


22/70



2. On the Select Installation Media screen, select the media from which to install:

Note:

Note: If you used /mnt/cdrom, select CDROMeven if you downloaded the script.

The Enter RPM URL screen appears.

3. Select the RPM URL.

The default entry is correct if you used /mnt/cdrom.

The Select Release Version screen appears.


23/70



4. Select the release version you are installing

The Co-residency warning page appears. This page warns you that running applications

co-resident on the AE Services server is not supported.

5. Respond to this warning:

SelectYesto acknowledge the warning and continue.

Select Noto abort the installation.

The Choose Installation Method screen appears.

6. Select Install to proceed with the installation.

The Choose Installation Packages screen appears.


24/70



7. Select both packages.

The Optional Packages screen appears.

This screen lists the optional packages that you can install.

8. Select the optional packages that you want to install.

mvap-linuxconfig

This choice installs the Linux configuration package.

We strongly recommend that you configure Linux by selecting mvap-linuxconfig on thisscreen.

mvap-cusldap

This choice configures an LDAP in the default location of /etc/openldap. We recommend

that you configure LDAP by selecting mvap-cusldapon this screen.

mvap-services

Installs the Avaya Services package for AE Services.

Select this package if you have a Services contract with Avaya. This package provides

tools and information, including Services login, to the Avaya Services personnel.

The Last Chance to Abort -- Ready to Proceed? warning screen appears.


25/70



9. Select yes.

The installation continues. The system displays the status of the installation. For example:

Wait for the Installation/Update completedmessage.


26/70



10. Select Exit.

The Successful completion screen appears:

Note:

Note: If the installation fails, a similar screen appears that says InstallationFailed.

11. To run AE Services after the installation, either reboot the system or manually restart

DBService, mvap, and tomcat5 by running the following commands:

/sbin/service DBService start

/sbin/service mvap start

/sbin/service tomcat5 start

See Chapter 4: Installing licensesfor information about installing the appropriate licenses.

Installed filesAs the AE Services Installer installs and unpacks the RPMs, it creates these directories and

files:

The main server directory

/opt/mvap

Note:

Note: Do not replace any of the directories under /opt/mvap with a symbolic link to

another directory. This may result in breakage and is not a supported

configuration.

The AES server startup configuration file

/etc/sysconfig/mvap

Log files

/opt/mvap/logs


27/70


28/70




29/70


Chapter 4: Installing licenses

All AE Services 3.1 users must install a license file, This section explains how to install the

AE Services license.

Installing the Application Enablement Services license file

The AE Services license file is distributed separately in an email from Avaya. If you have not

received a license file from Avaya, see If you do not have a license on page 31.

! Important:

Important: The WebLM Server and the AE Services server must be running on the same

machine. This is the default configuration. To check this, type:

https://aeshostname:port/WebLM

The WebLM page should come up.

Follow these steps to install the license file:

1. Locate the email containing the AE Services license file. Detach the license file from the

email, and store it locally on a PC. The PC that the license file is stored on does not have to

be same PC that the AE Services server is installed on.

2. Start your browser and type the appropriate URL based on this example:

https://aeshostname:port/WebLMwhere:

aeshostnameis your AE Services servers host name

portis your AE Services servers port number (the default port number is 8443)

For example:

https://myaessrv.abc.com:8443/WebLM

or

https://192.168.1.1:8443/WebLM

Note:Note: You can also shorten the URL by leaving out the port number:

https://aeshostname/WebLM/

Accept the SSL certificate that is presented. After accepting the certif icate, yourbrowser displays

the WebLM Administrator Login page.


30/70

Installing licenses


3. Accept the default User name (admin) and type the default password: weblmadmin. Thenclick Continue.

Your browser displays the Change Administrator Password page.

Note:

Note: WebLM issues the Change Administrator Password page the first time you log in

to WebLM. If you get a new license, you do not have to change your password

the next time you log in to WebLM.

4. Complete the Change Administrator Password page and click Change Password.

The browser goes back to the login page.

5. Log in as adminwith the new password you specified.

Your browser displays the Install License page.

6. Under Enter License Path, click Browseand locate the AE Services license file. Once youhave located the license file, click Install.

WebLM uploads the license file from your PC to the WebLM server and displays the

following message: License File is installed successfully.

If you do not receive this message, see Troubleshooting the AE Services license

installation.

7. Log out of WebLM and restart AE Services to use the capabilities of the new license.

Note:

Note: The hostname of the AE Services server must not be associated with the loop

back address 127.0.0.1. The hostname of the AE Services server should be

associated with the IP address of eth0

This completes the AE Services license installation.


31/70

Troubleshooting the AE Services license installation


Troubleshooting the AE Services license installation

Use the information in this section to troubleshoot problems you might encounter during

installation of the license. It covers the following topics:

If you receive error messages from WebLM

If you do not have a license

If you receive error messages from WebLM

If your browser displays the following messages, contact your Avaya representative.

If you do not have a license

If you discover that you have not received the AE Services license file in an email from Avaya,

contact your Avaya representative or Avaya Partner representative. To ensure that your requestis processed as quickly as possible, be ready to provide the information listed in Required

information for requesting a license file.

Message Explanation

License file is invalid or notcreated for this server. Licensefile was NOT installed.

The file is corrupt or the MAC address in thelicense file does not match the MAC addressin the server.

Attempting to install a licensefile that is currently installed.License file was NOT installed

The license has already been activated.

No valid license file found This WebLM message may appear after AESprovides this successful license installationmessage:

"license file installedsuccessfully"

If this happens, make sure that in step 2inInstalling the Application EnablementServices license file on page 29,aeshostnameis your AE Services servershost name (not the IP address).


32/70

Installing licenses


Note:

Note: You must send a separate request for each license file.

Identifying the MAC address

If you have already installed AE Services, use WebLM to identify the MAC address of the NIC

by following step 2of Installing the Application Enablement Services license file on page 29.

As an alternate method (if you have not installed AE Services), you can use the

Linux ifconfigcommand to identify the MAC address of the NIC on your PC.

1. From the Linux command prompt, type the following command: ifconfig

Linux displays the current information about the network interface. For example:

eth0 Link encap:Ethernet HWaddr 00:B0:D0:44:9F:A1

inet addr:10.10.10 Bcast:10.255.255.255 Mask:255.0.0.0

In this example, the MAC address (which corresponds to the HWaddr) is 00B0D0449FA1(when specifying a MAC address do not include colons).

2. Provide the MAC address to your service representative when you request a license.

! Important:

Important: If your server is configured with multiple NICs, provide the MAC address of the

first NIC. If your server is configured with a dual port NIC, provide the address of

the first port.

Table 2: Required information for requesting a license file

Required information Description

Return email address Avaya emails this license file to you. You mustprovide a secure email address where youwant to receive the license file.

MAC Address of the NIC For more information, see Identifying the MACaddress.


33/70


Chapter 5: Initial administration for AE Services

You must administer both Communication Manager and AE Services to complete the

installation of AE Services. This chapter provides tables of these administration procedures,which:

Establish initial connectivity between AE Services and Communication Manager:

Allow Communication Manager to interact with Application Enablement Services client

applications.

The tables direct you to the appropriate section or sections in theApplication Enablement

Services Administration and Maintenance Guide.The tables also explain the services for which

you perform each procedure.

Administering Communication Manager for AE Services

Procedure Performed if you usethese services

Where to find inAE Services Admin Guide

Check for call controlfeatures licensed onCommunicationManager

Call Control Checking for call control features licensedon Communication Manager, in Chapter1, Administering Communication Managerfor AE Services

Set up a transport link Check the referencedsections in theAdministration andMaintenance Guidetodecide which links youneed to set up.

Configuring IP Services in Chapter 1,Administering Communication Managerfor AE Services

Set up a CTI link Call Control Settings in Chapter 1,Administering Communication Managerfor AE Services


34/70

Initial administration for AE Services


Check for appropriateVOIP resources

Device, Media, and CallControl

Checking for appropriate VOIP resourcesin Chapter 1, AdministeringCommunication Manager for AE Services

Check for IP_API_Alicenses

Checking for IP_API_A licenses inChapter 1, Administering CommunicationManager for AE Services

Add stations for aDevice, Media, and CallControl application

Adding stations for the application inChapter 1, Administering CommunicationManager for AE Services

ConfigureCommunicationManager for signalingand media encryption

For signaling encryption:

Administering a network region in

Chapter 1, Administering

Communication Manager for AE

ServicesSee also the White-paper on Security

in Application Enablement Services

for Bundled and Software only

solutions. This white paper is

available on the Avaya support site

along with the customer documents.

For media encryption:

Checking for media encryption in

Chapter 1, Administering

Communication Manager for AE

Services

Procedure Performed if you usethese services



35/70

Administering AE Services


Administering AE Services

Procedure Perform procedure If

using:

Where to find in

AE Services Admin Guide

Create a user account forOAM access

All (without a servicescontract)

Adding a Linux user andsetting the OAM accountpassword in Chapter 7,Administering AE Servicesfrom the Operating SystemCommand Prompt

Administer CT users TSAPI, JTAPI and Device,Media, and Call Control

Adding a CT User to the AEServices User Servicedatabase inChapter 3, AE ServicesOAM administration and CTIOAM Administration

Specify NICs for AE Services All Administering the local IPfor all AE Services inChapter 3, AE ServicesOAM administration and CTIOAM Administration

Administer transport linkconnectivity toCommunication ManagerC-LAN/P-CLAN

Check the referencedsections in theAdministration andMaintenance Guidetodecide when to administer atransport link.

Administering SwitchConnections, in Chapter 2,AE Services OAMAdministration and CTI OAMAdministration

Administer H.323Gatekeepers

Device, Media, and CallControl

Administering SwitchConnections, in Chapter 2,AE Services OAMAdministration and CTI OAMAdministration

Administer links All call control Link Administration - CTILink Admin on AE ServicesOAM in Chapter 2, AEServices OAMAdministration and CTI OAMAdministration


36/70

Initial administration for AE Services


After completing all installation and configuration procedures, you should restart AE Services.

Where to go from hereYou have now completed the AE Services installation and the administrative tasks for achieving

connectivity between the AE Services server, Communication Manager (if necessary) and the

client. Chapter 6: Testing connectivityexplains how to test the connectivity.

You can test connectivity from the OAM Utilities pages.

See Running tests from the OAM pages on page 37.

If you are using Device, Media, and Call Control, you can also test the connectivity using

the provided sample application. All necessary files for this application are included in the

Application Enablement Services RPM.

For instructions on running the sample application, see:

Appendix A: Running the sample application (Device, Media, and Call Control only)

Check application linkencryption

Device, Media, and CallControl Services

Checking application linkencryption in Chapter 2, AEServices OAM

Administration and CTI OAMAdministration

Administer the SecurityDatabase settings

TSAPI or Telephony WebServices

Chapter 5, TSAPIConfiguration and theSecurity Database

Procedure Perform procedure Ifusing:



37/70


Chapter 6: Testing connectivity

You can test the connectivity between AE Services and Communication Manager in several

ways, depending on which capabilities you are using. You can run tests from the OAM pages.

You can run a sample application (Device, Media, and Call Control only).

Running tests from the OAM pages

You can use the following OAM Utilities pages to check connectivity:

ASAI Test - to test ASAI links Ping Host - to ping a host name IP address

TSAPI Test - to place a test phone call

The following table shows which OAM Utilities page can be used for which tools:

The location of these screens in the OAM are:

Utilities> ASAI Test

Utilities> Ping Host

Utilities >TSAPI Test

For information about running these tests, see the OAM Help pages.

ASAITest

PingHost

TSAPITest

Call Control(CVLAN/TSAPI)

X X

DLG X

Device, Media, andCall Control

X

Call Control (TSAPI) X X X

Telephony WebService

X


38/70

Testing connectivity


Testing connectivity by running the sample application

If you are using the Device, Media, and Call Control Services, you can also set up and use the

sample application created for these services. Running this application tests that the server files

are installed correctly and that you have achieved connectivity with Communication Manager.

SeeAppendix A: Running the sample application (Device, Media, and Call Control only).


39/70

Upgrade considerations for RFA license


Chapter 7: Upgrading and updating the AE Services

software

This section explains:

When you need to obtain a new RFA license while upgrading from 3.0 to 3.1

How to upgrade the AE Services software

How to apply updates and patches

For an explanation of the differences between updates and patches, see Updating the

software on page 44.

Upgrade considerations for RFA license

AE Services 3.1 can operate with an AE Services 3.0 license under many circumstances.

However, an AE Services 3.1 license is required in order to take advantage of new features and

capabilities.

We strongly recommend that you obtain a new 3.1 license even if you do not purchase any

changes to licensed features. This will ensure that any new features or capabilities that you may

use in the future will be supported without having to regenerate the license at that time.

You mustacquire a new license when you upgrade to AE Services 3.1 if you are:

Running Device, Media, and Call Control applicationsor

Running TSAPI Service with existing TSAPI Advanced User license

We recommend that you obtain the 3.1 RFA license before performing the upgrade.

Upgrading the software

This section provides the procedure for upgrading from AE Services 3.0 to AE Services 3.1 or

upgrading to a new 3.1 load. There are some differences in these procedures. Thesedifferences are noted in the appropriate sections.

Note:

Note: Upgrades can be performed only on a server that already has a version of AE

Services installed on it.


40/70

Upgrading and updating the AE Services software


Before you begin

Before an upgrade or update is performed:

1. Log in to the AE Services OAM pages.

a. Start your browser and type the appropriate URL based on this example:

https://aeshostname:port/MVAP

where:

aeshostnameis your AE Services servers host name

portis your AE Services servers port number (the default port number is 8443)

b. Log in.

The OAM Home Page opens.

2. Select CTI OAM Admin.

The CTI OAM Home Page opens.

3. Perform a backup from the OA&M Web pages to generate a 3.0 configuration data

backup file.

a. From the CTI OAM Main menu, select Maintenance > Backup Database.

b. On the Backup Database screen, click on hereand select the Savebutton.

c. Save the database backup file to a safe location that will not be affected by the AE

Services 3.1 installation.

The backup file is stored at that location under the name mvapdbddmmyyyy.tar.gz

For more information, see the section Backing up the database in Chapter 2, AE Services

OAM Administration and CTI OAM Admin in theApplication Enablement Services

Administration and Maintenance Guide.

4. Make sure you also back up any files in directories that are not automatically preserved.

This includes the home directories of accounts created by the previous installation (for

example, craft, avaya, sroot).

5. From the CTI OAM Main menu, select Administration > Local IPand record the Local IPsettings listed on the Local IP screen.

! Important:

Important: This following step is an important precaution in case the upgrade fails.


41/70



6. To maintain a synchronized LDAP and Postgres database.

a. Log in to the 3.0 AE Services server and su to a user with root privileges (for example,

use su - root).

b. From the command line, execute the following commands:

cd /var/lib/ldap

tar -cvf tar_file_name.tar *.dbb

c. Save the tar file in a safe location that will not be affected by the 3.1 installation.

7. (Only if upgrading from AE Services 3.0) Update Linux to Linux ES 3.0 update 5:

a. Insert the first Linux CD and reboot.

b. From the boot prompt: typelinux upgrade.

c. Follow the screens to one that says:

Perform an upgrade of an existing installation

Update boot loader configurationYou may see this message:

Upgrades for this version of Red Hat Enterprise Linux ES areonly supported from Red Hat Linux 6.2 or highter. This appearsto be an older system. Do you wish to continue the upgrade.

d. Select OK.

Performing the upgrade

You can upgrade AE Services from a CD or from an ISO image. This section explains theseprocedures.

To upgrade the software:

1. Log in to the server as a non-Avaya user and suto an account with root privileges(for example, using the command su - root).

2. From the command line, stop tomcat:

service tomcat4 stop

Note:

Note: If you are upgrading from one 3.1 load to another, you do not need to stop

tomcat.


42/70



3. From the command line, uninstall the AE Services 3.0 software:

swuninstall

Note:

Note: If you are ugrading from one 3.1 load to another, you do not need to uninstall.

4. From the command line, remove third-party software packages that are different in3.0 and 3.1.

rpm -e avaya-axis

rpm -e avaya-tomcat

rpm -e j2sdk-1_4_2_07-linux.i586.rpm

5. Run the installer by performing the appropriate steps from the following table.

For a complete explanation of running the installer, including example screens, see Running

the AE Services installeron page 20.

6. From the command line, start these services in this order:

service ldap startservice DBService start

service mvap startservice httpd startservice tomcat5 start

If upgrading from a CD If upgrading from an ISO image

a. Insert the CD containing the AEServices 3.1 and third-party RPMssoftware.

b. Start the AE Services Installer.

- If the Autorun RPM is already

installed and configured on your

machine, the AE Services installer

starts automatically.

- If the Autorun RPM was not already

installed and configured on your

machine, first mount the CD ROM

and then run the AE Services

Installer. Use these commands:

mount /mnt/cdrom/mnt/cdrom/install

a. Download the ISO image to the /tmp

directory on the AE Services server.

b. Using the following command, mount the

ISO image:

mount -t iso9660 -o loop XXX.iso/mnt/cdrom

Where XXX= the AE Services ISO Image

Build version.

c. Launch the Software-Only installer:

/mnt/cdrom/install


43/70



7. Verify that the upgrade was successful.

From the command line run swversionand verify that the version number and buildnumber are correct.

Validate the configuration data:

a. Log in to the AE Services OAM.

For more information, see step 1 in Before you begin on page 40.

b. Select CTI OAM Admin >Administration.

c. Check all of the OAM pages listed under Administrationon the Administration page.Verify that the information is complete and correct.

Perform these additional steps if all of the data is not there or if any of the data is incorrect.

8. Restore the database from the OAM:

a. From the CTI OAM Main menu, select Maintenance > Restore Database.

b. Follow the instructions on the Restore Database page.

9. Log in to the 3.1 AE Services sever and su to a user with root privileges(for example, using the command su - root).

10. Copy the saved tar file to /var/lib/ldap.

11. From the command line, execute the following commands:

cd /var/lib/ldap

tar -xvf tar_file_name.tar

rm tar_file_name.tar

service ldap restart

Installing a new license

We recommend that you install a new AE Services 3.1 license when you upgrade to AE

Services 3.1.

See Upgrade considerations for RFA license on page 39for more information.

See Chapter 4: Installing licensesfor information about installing licenses.

Whenever you install a new license, you must restart AE Services to get the new capabilities.

To restart AE Services:

1. Log in to the AE Services OAM.

For more information, see step 1 in Before you begin on page 40.

2. Select CTI OAM Admin >Maintenance >Service Controller.

3. Click the Restart AE Server button.


44/70



Updating the software

Avaya provides updates and patches for updating the software.

An update provides new features or enhancements to the AE Services platform. An update

may also include bug fixes. Updates are released only on an as-needed basis for critical

fixes. Avaya tests updates before releasing them.

A patch addresses a specific issue to a specific component or a set of components in the

AE Services platform. We do not test patches before releasing them.

The install script installs the new version of the RPMs in /var/disk/rpms.

Note:

Note: /var/disk/rpms also contains all of the previous versions of the RPMs.

The update script backs up the current version before installing the new version of the

RPM.

The next two sections explain how to install or uninstall updates or patches on an AE Services

server.

Installing updates and patches

Updates and/or patches are organized as ZIP files of RPMs. Multiple updates or patches can be

applied to the system.

! Important:

Important:

Always use thisprocedure, notan RPM command, to install AE Services updatesor patches.

You should check the Avaya DevConnect site (www.devconnectprogram.com) or the Avaya

support site (support.avaya.com)periodically to see if there is a new patch. If there is, install the

new updates and/or patches:

Note:

Note: You should always perform a backup of the database before installing an update.
http://www.devconnectprogram.com/http://www.support.avaya.com/http://www.devconnectprogram.com/http://www.support.avaya.com/


45/70

Updating the software


To install an update or a patch:

1. Log in to the AE Services server and su to a user with root privileges (for example, using the

command su - root).

2. Download any new patches (xxxx.zip) to the current directory.

3. From the command line, enter update -u xxxx.zip

The update/patch ID and the RPMs contained in the package are displayed and the system

prompts you to confirm the installation of the RPMs.

If you enter y, the installation of the updates/patches proceeds:

- AE Services, Tomcat service, and DBService are stopped.

- RPMs contained in the package are installed.

- AE Services, Tomcat service, and DBService are restarted.

If you enter n, the installation of the updates/patches aborts.

Use swversion -a if you want to look at all the updates/patches installed in the system.

Uninstalling updates and patches

Note:

Note: The directory /opt/mvap/resources/patch-update contains the patchnumber.txt

files. RPMs installed in each update/patch are listed in this patchnumber.txt file.

Use swversionif you want to look at all the updates/patches installed in thesystem.

To uninstall updates or patches:

1. Log in to the server machine where AE Services and patches are already installed.

2. su to a user with root privileges (for example, using the command su - root).

3. Use swversion -a to find out the number of the update/patch you want to remove.

4. From the command line, enter: update -epatchnumber.

The screen displays a list of all the RPMs to be uninstalled, and the system prompts you for

confirmation before uninstalling these RPMs.

If you enter y, the system uninstalls the updates/patches by performing these tasks:

- AE Services, Tomcat service, and DBService are stopped.

- RPMs specified inpatchnumber.txtare rolled back to the previous version.

- AE Services, Tomcat service, and DBService are restarted.

If you enter n, the upgrade script exits.


46/70



Uninstalling the AE Services software

To uninstall the AE Services software:

1. Uninstall all of the AE Services RPMs:

swuninstall.

This script is located in /opt/mvap/bin.

! Important:

Important: If you have any patches installed, you must first remove them before running

swuninstall.

Note:

Note: swuninstallalso removes the users (for example, avaya, craft, user).

2. After uninstalling the software, some configuration and log files will remain in the /opt/mvap

and /opt/ecs directories. You may remove these directories and their contents. Be sure tosave any configuration, properties or log files to a safe place before removing these

directories.

3. Stop tomcat5:

/sbin/service tomcat5 stop


47/70


Chapter 8: Security considerations and guidelines

For a complete discussion of the security considerations and guidelines for AE Services, see

the White-paper on Security in Application Enablement Services for Bundled and Software onlysolutions. This white paper is available on the Avaya support site along with the customer

documents.


48/70

Security considerations and guidelines



49/70


Appendix A: Running the sample application(Device, Media, and Call Control only)

If you are using the Device, Media, and Call Control capabilities of AE Services, the files forrunning several sample applications were installed. This section explains how to administer and

run one of these sample applications (the Tutorial application) in order to:

Test connectivity between AE Services and Communication Manager

Perform the various steps involved in running an application

Learn which files are involved in running an application

See some of the capabilities of an AE Services Device, Media, and Call Control application

Note:

Note: The Tutorial application is the only application that should be run directly on the

AE Services Server. All other applications should be run on another machine.

Before you begin

Before you can run the sample application, you must:

Administer AE Services for the sample application

Administer Communication Manager for the sample application

Edit the tutorial properties file

You will need to know the dial plan and which Communication Manager extensions are

available.

The sample application files

The following sample application and sample application-related files are included on the AE

Services server:

The application properties file for the sample application (the tutorial properties file)

/opt/mvap/cmapi/cmapijava-sdk/examples/resources/tutorial.properties


50/70

Running the sample application (Device, Media, and Call Control only)


The sample application media files

/opt/mvap/cmapi/cmapijava-sdk/examples/media/0001.wav


opt/mvap/cmapi/cmapijava-sdk/examples/media/0003.wav


A README file containing a description of how to set up and run the sample application.

/opt/mvap/cmapi/cmapijava-sdk/examples/bin/README.txt

These files are referred to throughout the following procedures.

Administer AE Services for the sample application

Note:

Note: This is a change for Device, Media, and Call Control Services, which previouslywas known as Communication Manager API. In Communication Manager API,

you specified configuration and application properties in the configuration

properties file. Now all properties are specified through the OAM.

To administer AE Services for the sample application:

1. Ensure that you have specified the same directory for these fields on the OA&M Media

Properties screen:

- Player Directory

- Recorder Directory

Note:Note: The default value for both fields is /tmp.

2. Copy the application media files (listed in The sample application files on page 49) into the

directory you have specified for Player Directoryand Recorder Directory.

Administer Communication Manager for the sample

application

To run the sample application, you must administer the following on Communication Manager:

Administer a station to use with the application

(If needed) Administer out-of-band digit detection

(If not already configured) Configure network region and gateway configuration


51/70



Administer a station

Use the Communication Manager add stationcommand to add a station.

For instructions on adding a station (including an example screen for AE Services), see Adding

stations for the API application in Chapter 1, Administering Communication Manager for AEServices inApplication Enablement Services 3.0 Administration and Maintenance Guide.

For a screen reference, see Station in the Screen Reference chapter of the Administrator

Guide for Avaya Communication Manager, 03-300509 (For Communication Manager 3.0).

Administer network region/gateway configuration (if needed)

See the section Setting up a network region for Device, Media, and Call Control and Adding a

media gateway to the network, in Chapter 1, Administering Communication Manager for AE

Services inApplication Enablement Services 3.0 Administration and Maintenance Guide.


Before you can run the sample application, you must edit the tutorial properties file

(tutorial.properties) to provide information specific to your configuration.

To edit the tutorial properties file:

1. Open tutorial.properties:

/opt/mvap/cmapi/cmapijava-sdk/examples/resources/tutorial.propertiesThis is the text of tutorial.properties:

# IP address of Communication Manager (CLAN)

callserver=nnn.nnn.nnn.nnn

extension=nnnn

password=nnnn

# codec choices: g711U, g711A, g729, g729A

codec=g711U

# encryption choices: aes, none

encryption=none

# IP address of AE Server

cmapi1.server_ip=nnn.nnn.nnn.nnn

cmapi1.username=

cmapi1.password=# Port for client to connect to AE Server

cmapi1.server_port=4722

# Port 4722 is encrypted

cmapi1.secure=true

#cmapi.trust_store_location=sdk/build/mvsdk/cmapijava-sdk/examples/resources/avaya.jks


52/70



2. Replace the ns with the following values, using the text editor of your choice:

a. For callserver, enter the IP address of the media server for Communication Manager,either.

- (with an S8300 media server) The IP address of the media server

or

- (with any other media server) The IP address of the C-LAN

b. For extension, enter the extension number of the station that you administered for thisapplication. SeeAdminister a station on page 51.

c. For password, enter the security code you administered for that station. SeeAdministera station on page 51.

3. Save and close tutorial.properties.

Running the sample application

Note:

Note: The AE Services server must be running before you can run an application.

To run the sample application:

1. sshinto the AE Services server.

2. On the AE Services server change to the directory where the demonstration application run

script resides:

cd /opt/mvap/cmapi/cmapijava-sdk/examples/bin

3. Run Ant on the tutorial application:

/opt/mvap/cmapi/cmapijava-sdk/examples/bin/ant.sh runTutorial(./ant.sh runTutorial)

The application starts running. This application acts as a softphone and waits for calls.

When the extension is called from any other phone, it answers with a recorded greeting that

prompts you to record a message.

4. You can experiment with this application:

a. Call the extension and listen to the recorded greeting.

b. Follow the prompts to record a message and have it played back to you.


53/70

Troubleshooting the sample application


Note:

Note: The sample application can only play the last recorded message on a given call.

If you make a new call, you will not hear a recording from a previous call. All the

recorded files are saved in the directory you have specified in the OAM as the

location of the recorded files.

Note:Note: There are also other sample applications installed with the server. After you have

checked the AES server/Communication Manager connectivity by running this

application, you may want to run those applications from an application machine.

Troubleshooting the sample application

If the application does not run or does not run as expected:

Check the log files on the server in /opt/mvap/logs:

- mvap-trace.log.x

- mvap-error.log.x

- mvap-api.log.x

- mvap-wrapper.log

The best log file to check for Exceptions when troubleshooting is the mvap-error.log.0 file

(The.0 file is the latest log file).

Check for application error messages:

Application error message: Troubleshooting procedure

Registration failed becauseGatekeeper Reject reason:terminalExcluded

Ensure that the extension number in tutorial.propertiescorresponds to a correctly administered extensionnumber in Communication Manager.

Registration failed becauseGatekeeper Reject reason:securityDenial

Verify that the password in tutorial.properties matchesthe password administered in CommunicationManager for the station.


54/70



For information about creating and deploying Device, Media, and Call Control applications for

AE Services, see the following books:

Application Enablement Services Device, Media, and Call Control Java Programmer

Guide (02-300359)

Application Enablement Services Device, Media, and Call Control Java Programmer

Reference (Javadoc)

Application Enablement Services Device, Media, and Call Control XML Programmer

Guide (02-300358)

Application Enablement Services Device, Media, and Call Control XML ProgrammerReference(XMLdoc)

Registration failed becauseProtocol Timeout: reason:GRQ timer, tried 3 times

Verify that the IP address in tutorial.properties for thecall server (media server) is correct. Ensure that youcan pingthe media server from the AE Servicesserver.

Connection refused Check the tutorial.properties file to make surethat the IP address of the AE Services server is

correct.

Check for network problems between the

application machine and the AE Services

server. One way to check this is to ping the AE

Services server from the application server.

Check the /etc/hosts files to verify that you have

included a line that explicitly lists the IP address

of the AE Services server, in addition to the

localhost line.

Application error message: Troubleshooting procedure


55/70

Setting up the Linux PC for remote access


Appendix B: Setting up for remote access(serial modem only)

This information is required if you have contracted with Avaya for maintenance and/or service.

Avaya Services personnel require remote access to the Linux PC to install, administer, and

maintain the AES server.

This appendix includes the following topics.

Setting up the Linux PC for remote access on page 55

Setting up the client to dial in to the serveron page 58

Remote access arrangement


Setting up a Linux PC for remote access requires a modem and installing two software

components (pppand mgetty). This appendix describes how to install pppand mgettyandhow to configure the PC after you have installed these two software components.

Before You Begin

If you have a Linux PC with the default Red Hat Enterprise Linux software components already

installed, the only additional requirements are as follows

Red Hat Enterprise Linux-compatible modem

ppp-- Point-to-Point Protocol software

mgetty-- a program that handles modem communications

AES Server

Administration

inittablogin.configpap-secretsppp optionsoptions ttyname

ppp

mgetty

Linux

Windows

PSTN


56/70

Setting up for remote access (serial modem only)


Use this checklist to make sure you are ready to start.

You are logged in as root.

You are at the command prompt.

You have the complete Red Hat Enterprise Linux ES CD-ROM set on hand.

Installing the additional software components

From the command prompt, follow this procedure to install ppp and mgetty.

1. Insert the Red Hat Enterprise Linux Installation CD-ROM disk 2 into the CD-ROM drive, and

type the following command to mount the file system:

mount /mnt/cdrom/

2. Type the following command to change to the directory containing the RPM packages:

cd /mnt/cdrom/RedHat/RPMS

3. Type the following command to install ppp.

rpm -i ppp-2.4.1-14.1.i386.rpm

4. Type the following command to install mgetty.

rpm -i mgetty-1.1.30-3.i386.rpm

This completes the procedure to install pppand mgetty. Continue with Configuring the LinuxPC on page 56.

Configuring the Linux PCOnce you have the installed necessary software, carry out the tasks described in the following

sections to configure the Linux PC.

Editing the inittab file on page 57

Editing the login.config file on page 57

Editing the options.tty file on page 58

Checking the PPP options file on page 58

Editing the options.tty file on page 58

Note:Note: All of these procedures assume that you are using a text editor such as vi or

emacs.


57/70



Editing the inittab file

Edit the /etc/inittab file, and add one line for each modem you plan to use. For example:

S0:2345:respawn:/sbin/mgetty -D ttyS0

Editing the login.config file

Edit the /etc/mgetty+sendfax/login.config file by uncommenting the AutoPPP line and editing it

to include a reference to the options file (by specifying file /etc/ppp/options), as shown below:

/AutoPPP/ - a_ppp /usr/sbin/pppd file /etc/ppp/options

Editing the pap-secrets file

For PAP (Password Authentication Protocol) authentication, edit the /etc/ppp/pap-secretsfile,so that it consists of one line containing the following characters: * * " " *

For example:

These settings enable any registered user to log in. (Alternatively, you could specify user

names, passwords and IP addresses.)

-Dis the parameter for a data modem

ttyS0 is the device identifier (Varies according to your hardware.For example, ttyS0is associated with COM1 and ttyS1is associated with COM2)

# Secrets for authentication using PAP

# client server secret IP address

* * ""

*


58/70


59/70

Setting up the client to dial in to the server


Windows clients

From a Windows client, use Windows Dial-up Network Connections to establish a PPP

connection to the AES server.

Linux clients

From a Linux client, use either the GNOME or KDE Dialer to establish a PPP connection to the

AES server.

Connection Requirements

Verify the PPP connection requirements and administer accordingly, for example: You may need to administer a login and password for the client connection. By default, no

login and password are administered on the AES server.

You will need to administer an IP address for the client connection. The default Client IP

address is 192.168.25.20.


60/70


61/70


Appendix C: Configuring an LDAP server forCommon User Service utilization

This appendix explains how to manually configure an LDAP Server for Common User Serviceutilization.

These instructions assume that the target LDAP is an OPEN LDAP server of version 2.1.22-28

or later.

Prerequisites

the mvap-userserviceRPM must be installed (the mvap-cusldap RPM is not needed) before

you can configure the LDAP server.

The mvap-userserviceRPM was installed with the third-party RPMs when you installed theserver software:

Configure the LDAP server

To manually configure your LDAP Server for Common User Service utilization:

1. Copy the mvapus schema file (mvapus.schema) from /var/mvap/config/cus to the LDAPschema directory (/etc/openldap/schema)

2. Edit the /etc/openldap/schema/core.schema file:

a. Locate the useridattribute specification section.

b. Add the following specification element:

ORDERING caseIgnoreOrderingMatchafter the EQUALITY caseIgnoreMatchline.

c. Save the file.

3. Edit the /etc/openldap/slapd.conf file

4. Add the following include statement to the already existing set of \includestatements:include /etc/openldap/schema/mvapus.schema

5. Note the suffix value used in the current slapd.conf file

6. Save and close the slapd.conf file.


62/70

Configuring an LDAP server for Common User Service utilization


7. Modify the init.ldif file to match the chosen organizationalUnit for the \usersand theexisting suffix used by the enterprise:

a. Eliminate the first entry in the init.ldif file.

b. Revise the second entry to reflect the desired organizationalUnit \(ex.ou=users)

c. Revise the DNattribute of the next two entries to reflect the chosenorganizationalUnitand suffix in use in the enterprise.

8. Save and close the init.ldif file.

9. Restart the LDAP server.

10. Use the ldapaddtool or equivalent to add the entries in the ldif.init file into the LDAPserver:

ldapadd -x -D bind credentials DN-W -f init.ldif

Create an LDAP User account

You must now create an LDAP user account for the User Service. This account must have

privileges to add, modify, and delete avayauserclass entries in the specified region of theDirectory Information Tree (DIT).

To create and administer an LDAP User account:

1. Open the /var/mvap/config/cus/user.properties file for editing

2. Edit he LDAP storage section to reflect the LDAP configuration work completed in

Configure the LDAP serveron page 61:a. Set the LDAP provider to the correct host and suffix combination.

b. Set the userrootproperty to the suffix value in use.

c. Set the principal to the DN of the LDAP you created in Configure the LDAP serveron

page 61.

d. Set the password attribute to the generated encrypted value.

Run /usr/share/tomcat5/webapps/axis/WEB-INF/lib/makepassword.shagainst the plain text password furnished by the enterprise LDAP administrator for the

User account you created.

e. Set the orgunitproperty to the organizationalUnit selected for the user dataspace.

3. Save and close the modified user.properties file.

4. Make identical changes to the corresponding properties in the

var/mvap/config/cus/ldapfilter.properties file.


63/70

Create an LDAP User account


5. If the User Service has not already been deployed by the relevant Tomcat/Axis server, then

deploy the service:

a. Make sure the Tomcat service is running.

b. Go to:

/usr/share/tomcat5/webapps/axis/WEB-INF/lib/

c. Run the org.apache.axis.client.AdminClientapplication against thecusdeploy.wsdd file.

For example:

java -classpath Axis jar filesorg.apache.axis.client.AdminClientcusdeploy.wsdd

6. Restart the Tomcat service that is the container for the User Service.


64/70

Configuring an LDAP server for Common User Service utilization



65/70


Appendix D: AE Services WAN requirements

The WAN requirements changed in AE Services 3.1

This section details the requirements for the customers network to support CTI links over a

WAN/VLAN/LAN. These are links, connected via a WAN/VLAN/LAN, between the AE Services

server machine and the CLAN(s) in a Communication Manager (CM).

No more than a 200ms average round trip packet delivery time as measured with pingover every one-hour time period

Periodic spiked delays of no more than two seconds while maintaining the 200ms average

ound trip delivery time as measured with pingover every one-hour time period

These requirements are to maintain the CTI link over a WAN/VLAN/LAN. If the implementation

is going to issue route requests, then the associated "wait" step must always have a value

greater than the largest "periodic spiked delay". With a maximum of 2 seconds allowed (as

stated above) your wait step should be greater than 2 seconds. If you can guarantee "periodicspiked delays" less than 2 seconds, then you can reduce the wait step time-out accordingly. If

no response to a route select is received by the switch, the call will follow the remaining vector

steps in this specific vector. In other words, you will program the vector to deal with this

condition.

If you cannot guarantee "periodic spiked delays" of less than two seconds, then it is important to

note the following condition:

If you are using AE Services 3.1 and encounter "periodic spiked delays" greater than two

seconds, then messages will either be:

Stored and retransmitted after recovering from a short network outage

or

Dropped during a long network outage.


66/70

AE Services WAN requirements



67/70


Index

Index

Aadministering

CT users . . . . . . . . . . . . . . . . . . . . 35H.323 Gatekeepers . . . . . . . . . . . . . . . 35links. . . . . . . . . . . . . . . . . . . . . . 35Security Database settings . . . . . . . . . . . 36transport link connectivity. . . . . . . . . . . . 35

administration procedures

AE Services . . . . . . . . . . . . . . . . . . 35Communication Manager. . . . . . . . . . . . 33

AE Server machine

avaya multivantage

Documents