Installing Avaya Agile Communication Environment Foundation Toolkit

Transcription

1 Installing Avaya Agile Communication Environment Foundation Toolkit Issue 1 March 2011

2 2011 Avaya Inc. All Rights Reserved. Notice While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes. Documentation disclaimer Documentation means information published by Avaya in varying mediums which may include product information, operating instructions and performance specifications that Avaya generally makes available to users of its products. Documentation does not include marketing materials. Avaya shall not be responsible for any modifications, additions, or deletions to the original published version of documentation unless such modifications, additions, or deletions were performed by Avaya. End User agrees to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation, to the extent made by End User. Link disclaimer Avaya is not responsible for the contents or reliability of any linked Web sites referenced within this site or documentation provided by Avaya. Avaya is not responsible for the accuracy of any information, statement or content provided on these sites and does not necessarily endorse the products, services, or information described or offered within them. Avaya does not guarantee that these links will work all the time and has no control over the availability of the linked pages. Warranty Avaya provides a limited warranty on its Hardware and Software ( Product(s) ). Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya s standard warranty language, as well as information regarding support for this Product while under warranty is available to Avaya customers and other parties through the Avaya Support Web site: Please note that if you acquired the Product(s) from an authorized Avaya reseller outside of the United States and Canada, the warranty is provided to you by said Avaya reseller and not by Avaya. Licenses THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA WEBSITE, ARE APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC., ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER (AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR AN AVAYA AUTHORIZED RESELLER; AVAYA RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING, DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER REFERRED TO INTERCHANGEABLY AS YOU AND END USER ), AGREE TO THESE TERMS AND CONDITIONS AND CREATE A BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE APPLICABLE AVAYA AFFILIATE ( AVAYA ). Avaya grants End User a license within the scope of the license types described below. The applicable number of licenses and units of capacity for which the license is granted will be one (1), unless a different number of licenses or units of capacity is specified in the Documentation or other materials available to End User. Designated Processor means a single stand-alone computing device. Server means a Designated Processor that hosts a software application to be accessed by multiple users. Software means the computer programs in object code, originally licensed by Avaya and ultimately utilized by End User, whether as stand-alone Products or pre-installed on Hardware. Hardware means the standard hardware originally sold by Avaya and ultimately utilized by End User. License types Designated System(s) License (DS). End User may install and use each copy of the Software on only one Designated Processor, unless a different number of Designated Processors is indicated in the Documentation or other materials available to End User. Avaya may require the Designated Processor(s) to be identified by type, serial number, feature key, location or other specific designation, or to be provided by End User to Avaya through electronic means established by Avaya specifically for this purpose. Concurrent User License (CU). End User may install and use the Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the Software at any given time. A Unit means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an or voice mail account in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Software that permits one user to interface with the Software. Units may be linked to a specific, identified Server. Database License (DL). End User may install and use each copy of the Software on one Server or on multiple Servers provided that each of the Servers on which the Software is installed communicate with no more than a single instance of the same database. CPU License (CP). End User may install and use each copy of the Software on a number of Servers up to the number indicated by Avaya provided that the performance capacity of the Server(s) does not exceed the performance capacity specified for the Software. End User may not re-install or operate the Software on Server(s) with a larger performance capacity without Avaya's prior consent and payment of an upgrade fee. Named User License (NU). End User may: (i) install and use the Software on a single Designated Processor or Server per authorized Named User (defined below); or (ii) install and use the Software on a Server so long as only authorized Named Users access and use the Software. Named User, means a user or device that has been expressly authorized by Avaya to access and use the Software. At Avaya's sole discretion, a Named User may be, without limitation, designated by name, corporate function (e.g., webmaster or helpdesk), an or voice mail account in the name of a person or corporate function, or a directory entry in the administrative database utilized by the Software that permits one user to interface with the Software. Shrinkwrap License (SR). Customer may install and use the Software in accordance with the terms and conditions of the applicable license agreements, such as shrinkwrap or clickthrough license accompanying or applicable to the Software ( Shrinkwrap License ). (see Third-party Components for more information). Copyright Except where expressly stated otherwise, no use should be made of materials on this site, the Documentation, Software, or Hardware provided by Avaya. All content on this site, the documentation and the Product provided by Avaya including the selection, arrangement and design of the content is owned either by Avaya or its licensors and is protected by copyright and other intellectual property laws including the sui generis rights relating to the protection of databases. You may not modify, copy, reproduce, republish, upload, post, transmit or distribute in any way any content, in whole or in part, including any code and software unless expressly authorized by Avaya. Unauthorized reproduction, transmission, dissemination, storage, and or use without 2 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

3 the express written consent of Avaya can be a criminal, as well as a civil offense under the applicable law. Third-party components Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ( Third Party Components ), which may contain terms that expand or limit rights to use certain portions of the Product ( Third Party Terms ). Information regarding distributed Linux OS source code (for those Products that have distributed the Linux OS source code), and identifying the copyright holders of the Third Party Components and the Third Party Terms that apply to them is available on the Avaya Support Web site: Preventing Toll Fraud Toll fraud is the unauthorized use of your telecommunications system by an unauthorized party (for example, a person who is not a corporate employee, agent, subcontractor, or is not working on your company's behalf). Be aware that there can be a risk of Toll Fraud associated with your system and that, if Toll Fraud occurs, it can result in substantial additional charges for your telecommunications services. Avaya Toll Fraud Intervention If you suspect that you are being victimized by Toll Fraud and you need technical assistance or support, call Technical Service Center Toll Fraud Intervention Hotline at for the United States and Canada. For additional support telephone numbers, see the Avaya Support Web site: Suspected security vulnerabilities with Avaya products should be reported to Avaya by sending mail to: securityalerts@avaya.com. Trademarks The trademarks, logos and service marks ( Marks ) displayed in this site, the Documentation and Product(s) provided by Avaya are the registered or unregistered Marks of Avaya, its affiliates, or other third parties. Users are not permitted to use such Marks without prior written consent from Avaya or such third party which may own the Mark. Nothing contained in this site, the Documentation and Product(s) should be construed as granting, by implication, estoppel, or otherwise, any license or right in and to the Marks without the express written permission of Avaya or the applicable third party. Avaya is a registered trademark of Avaya Inc. Avaya Aura is a registered trademark of Avaya Inc. Avaya ACE is a registered trademark of Avaya Inc. All non-avaya trademarks are the property of their respective owners, and Linux is a registered trademark of Linus Torvalds. Downloading Documentation For the most current versions of Documentation, see the Avaya Support Web site: Contact Avaya Support Avaya provides a telephone number for you to use to report problems or to ask questions about your Product. The support telephone number is in the United States. For additional support telephone numbers, see the Avaya Web site: Installing Avaya Agile Communication Environment Foundation Toolkit March

4 4 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

5 Contents Chapter 1: Introduction...7 Foundation Runtime Services...7 Foundation SDK...8 Security features...9 Chapter 2: Installing Foundation Toolkit...11 Installation overview...11 Installation checklist...12 Installing Foundation Toolkit...13 Installing Avaya Media Server...15 Configuring Avaya ACE servers as SIP Entities...17 Communication Manager configuration...18 Disabling HTTP access...19 Verifying installation...19 Uninstalling Foundation Toolkit...20 Foundation Toolkit installation parameter descriptions...20 Chapter 3: Troubleshooting...23 Client application encounters media server-related exceptions...23 Connecting to the media server...23 No connection to Session Manager...24 Connecting to Session Manager...24 Client applications cannot connect to Foundation Toolkit...24 Foundation Toolkit server unavailable...25 Trust management errors...25 ServletExceptions during logging...26 Run AAFT process with root user permissions...26 Unknown WebSphere primary administrative account password...26 Resetting the WebSphere administrative password...27 Index...29 Installing Avaya Agile Communication Environment Foundation Toolkit March

6 6 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

7 Chapter 1: Introduction Avaya ACE Foundation Toolkit allows integration of applications within the Avaya Aura network for midsize to large enterprises. Leveraging the revolutionary Session Initiation Protocol (SIP) architecture of Avaya Aura, and deployed within Avaya Agile Communication Environment, Foundation Toolkit enables fast and easy deployment of communications capabilities such as voice, messaging, and presence. As a result, productivity and business agility can be increased. With Foundation Toolkit, corporate application developers, third-party independent software vendors, and system integrators, who have a basic, but not extensive, knowledge of SIP, can take advantage of the functionality of the Avaya communication solutions. Foundation Toolkit enables custom integration with a broad range of communications, business, Call Center, Call Recording and Click-to-Dial solutions. Foundation Toolkit has two components: the Foundation Runtime Services and the Foundation SDK. Foundation Runtime Services The Foundation Runtime Services are the server-side part of the Foundation Toolkit. The Foundation Runtime Services are installed as part of an Avaya ACE server and expose the functionality of Avaya Aura as services to client applications, so client applications can make and receive calls, or manipulate call flows. The interfaces to the Foundation Runtime Services allow you to control SIP calls, inject media into calls and route calls through a series of applications. The Foundation Runtime Services, in combination with Avaya Aura Session Manager, allow your applications to: Initiate, reject and accept SIP call flows Inject media into a SIP call flow, for example: - Play messages, tones and music - Collect DTMF tones - Create two-party calls - Create multiparty conference calls Record parties in calls Route and proxy calls onward according to a user s configuration Installing Avaya Agile Communication Environment Foundation Toolkit March

8 Introduction Apply call forwarding, call restrictions, call permissions and other enterprise rules and policies Route calls to personal assistant applications Route calls to voice mail Installing and administering the Foundation Runtime Services The Foundation Runtime Services are installed by the Agile Communication Environment Installer. The Foundation Runtime Services are administered and monitored through the Agile Communication Environment Web-based graphical user interface. Foundation SDK The Foundation SDK includes the Foundation Toolkit client-side libraries, which connect client applications to the server part of the Foundation Toolkit. The Foundation Toolkit client-side libraries expose the Foundation Toolkit API, which can be used to access the Foundation Toolkit services. The Foundation Toolkit API is documented through extensive Javadoc and the Avaya Agile Communication Environment Foundation Toolkit Developer's Guide. The Foundation SDK also includes sample applications and provides recommendations for the development and testing of Foundation Toolkit client applications. Using the Foundation SDK you can: Integrate applications within an Avaya Aura enterprise network Integrate telephony applications quickly, with only a basic understanding of SIP Develop telephony applications which are triggered sequentially when a user makes or receives a call. Develop applications to control calls with features such as call barring, click-to-dial, interactive voice response (IVR), voice mail and call redirection. Integrate media services such as conferencing, collecting DTMF, playing tones and announcements, and recording and playing back calls. Deploy telephony and enterprise applications within a Java EE container or as standalone Java SE client applications. 8 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

9 Security features Security features Foundation Toolkit has the following security features: Client applications can connect to the Foundation Runtime Services with a secure HTTPS connection. System Manager acts as the certificate authority for the HTTPS connection. Client applications are treated as trusted elements in the Avaya Aura network. For example, user identities asserted in SIP messages sent by a client application are trusted by Session Manager. SIP communication with Session Manager is over TLS. Security certificates are provisioned by System Manager. Installing Avaya Agile Communication Environment Foundation Toolkit March

10 Introduction 10 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

11 Chapter 2: Installing Foundation Toolkit Installation overview 1 Foundation Runtime Services. The Foundation Toolkit installer installs the Foundation Runtime Services on a platform hosting Avaya ACE. The Foundation Toolkit installer must be run after the Avaya ACE installer has successfully completed installation on a supported platform. For more information on installing Avaya ACE, see the Avaya Agile Communication Environment Planning and Installation guide. 2 Client application built using the Foundation SDK. Client applications built with the Foundation SDK can connect to the Foundation Runtime Services through a connection URI similar to the following: Installing Avaya Agile Communication Environment Foundation Toolkit March

12 Installing Foundation Toolkit where frsip is the host name or IP address of the Avaya ACE server and portno is the port used on the server (default is 9444). 3 The Foundation Toolkit installer must be provided with the network address and TLS port of Session Manager. After installation, an Entity Link must be created in System Manager between the Session Manager TLS port (typically 15060) and the Foundation Toolkit Secure SIP port (default 5063). 4 The Foundation Toolkit installer must be provided with a URI for Avaya Media Server. For example: sip:msml@ms.example.com:5060;transport=tcp Note: For more information on installing Avaya Media Server, see Installing Avaya Media Server on page The network may also include Communication Manager, which must be configured for interoperation with Foundation Toolkit. For more information, see Communication Manager configuration on page The installer configures Foundation Toolkit for trust management, so that secure connections can be established with client applications. The installer must be provided with: System Manager host name or IP address. Certificate Enrollment Password. This must match the password configured in System Manager. For more information, see the System Manager online Help system. Host name or IP address of the Avaya ACE server hosting the Foundation Runtime Services. Installation checklist # Installation task Notes 1 If already installed, Foundation Toolkit must be uninstalled prior to reinstallation. See Uninstalling Foundation Toolkit on page Avaya Media Server must be installed when client applications make use of Foundation Toolkit 12 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

13 Installing Foundation Toolkit # Installation task Notes media services (including call recording, IVR and conferencing). See Installing Avaya Media Server on page Foundation Toolkit must be installed on a platform on which the Avaya Agile Communication Environment is already installed. See Installing Foundation Toolkit on page The System Manager containing Foundation Toolkit must be configured in Session Manager as a SIP Entity. See Configuring Avaya ACE servers as SIP Entities on page Communication Manager, if present, must be configured to operate correctly with Foundation Toolkit. See Communication Manager configuration on page Verify the installation. See Verifying installation on page 19. Installing Foundation Toolkit Prerequisites Supported platform Avaya ACE Release The Foundation Toolkit installer installs the Foundation Runtime Services on a platform hosting Avaya ACE. The Foundation Toolkit installer must be run after the Avaya ACE installer has successfully completed installation on a supported platform. For more information on installing Avaya ACE, see the Avaya Agile Communication Environment Planning and Installation guide. Installing Avaya Agile Communication Environment Foundation Toolkit March

14 Installing Foundation Toolkit Network environment The network must include instances of: Avaya Aura Session Manager Note: Avaya Media Server is also required if client applications make use of any Foundation Toolkit media services. for the required version numbers of these elements, see the Foundation Toolkit Release Notes. 1. Run the installation script: /opt/avaya/ace-xxx/install/install_aaft.sh, where xxx is a version number. 2. The installation script prompts for a number of installation parameters. For more information, see Foundation Toolkit installation parameter descriptions on page The installation script displays the values entered for the installation parameters. Confirm the values to start the installation process. Once the installation has completed, the script displays the message COMPLETED. Result The installation script installs Foundation Toolkit and starts the AAFT process (the Foundation Toolkit process). If you need to start or stop the AAFT process after installation, do the following: 1. On the Avaya ACE server, open the following directory: opt/ibm/websphere/ AppServer/profiles/AppSrv01/bin. 2. To start the AAFT process, enter the command: startserver.sh AAFT. To stop the AAFT process, enter the command: stopserver.sh AAFT. Note: The scripts prompt you for the WebSphere primary administrative account password, set during installation. (Optional) The default installation of the Avaya ACE server and Foundation Toolkit has been optimized to allow a deployment where both Avaya ACE and Foundation Toolkit services are operational. If the target deployment only requires Foundation Toolkit services to be operational then it is possible to improve performance by increasing the Heap Size in the Java virtual machine: 14 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

15 Installing Avaya Media Server 1. In the Avaya Agile Communication Environment Web GUI, click Application servers > AAFT > Server Infrastructure > Java and Process Management > Process definition > Java Virtual Machine. 2. Increase the settings for Initial heap size and Maximum heap size. For example, set both of these to 4GB. Installing Avaya Media Server Prerequisites Supported operating systems Number of processor cores Processor speed Processor level 2 cache size Memory Number of network connections Free disk space Red Hat Enterprise Linux 5.x (32-bit and 64-bit) CentOS 5.x (32-bit and 64-bit) Minimum: 2 Recommended: 8 Minimum: 1.2 GHz Recommended: 2.5 GHz Minimum: 255 KB Recommended: 512 KB Minimum: 2 GB Recommended: 4 GB Minimum: 1 Recommended: 2 (teamed as a virtual adapter) 3 GB free on any disk partition where Avaya Media Server software will be installed 1. Download the Avaya Media Server installer. Copy the file to the target platform. 2. Change to root user by executing the command su. 3. Give executable permissions to the installer: chmod 755 MediaServer_xxx.bin where xxx is the version number of the installer. 4. Start the installer by using the command:./mediaserver_xxx.bin 5. The installer displays the License Agreement. Press Enter to page through the license agreement. 6. If the license is acceptable, enter Y to accept the terms of the license agreement. Installing Avaya Agile Communication Environment Foundation Toolkit March

16 Installing Foundation Toolkit Note: You can only install the Avaya Media Server if you accept the license agreement. 7. When prompted Install Element Manager?, enter Y. 8. When prompted for the Linux group name, press Enter to accept the default of root. This restricts access to the Avaya Media Server Element Manager to members of this Linux group on the server hosting Avaya Media Server. The operating systemlevel user names and passwords of this Linux group can be used to access the Avaya Media Server Element Manager 9. When prompted Where would you like to install?, press Enter to accept the default of /opt/avaya. The installer displays the progress of the installation. 10. Ensure the Avaya Media Server services are running. Execute the following commands to check each service: service avaya.mysql status service avaya.mediaserver status service avaya.em status service avaya.snmp status service avaya.sysmonitor status service avaya.plic status Tip: To start the services, execute the following commands: service avaya.mysql start service avaya.mediaserver start service avaya.em start service avaya.snmp start service avaya.sysmonitor start service avaya.plic start Tip: To stop the services, execute the following commands: service avaya.mysql stop service avaya.mediaserver stop service avaya.em stop service avaya.snmp stop service avaya.sysmonitor stop service avaya.plic stop 11. In your browser, navigate to to open the Avaya Media Server Element Manager, where amsaddress is the host name or IP address of the AvayaMedia Server. 12. License the AvayaMedia Server: 16 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

17 Configuring Avaya ACE servers as SIP Entities a. In the Avaya Media Server Element Manager, click Licensing > General Settings. b. Select Nodal Licensing. c. Enter the license Key and click Save. d. Restart the Avaya Media Server host machine. 13. Configure the SIP settings. a. In the Avaya Media Server Element Manager, click System configuration > Signalling Protocols > SIP > General Settings. b. In the Routing area, clear Enforce SIP Route Configuration. c. In the Access Control area, clear Trusted Node Access Only and click Save. d. In the Avaya Media Server Element Manager, click System configuration > Signalling Protocols > SIP > Domains and Accounts. e. On the SIP Domains and Accounts page, add the domain names required for your network. For example, add domains such as example.com and avaya.com. 14. Copy media files to the Avaya Media Server: a. Connect to the Avaya Media Server host machine using SSH. b. Create a new directory named (for example) Announcements/provisioned at the location /opt/avaya/ma/mas/platdata/filestorage/announcements/ provisioned. c. Copy the media files to the provisioned directory. For example, copy the media file ninety-nine.wav to /opt/avaya/ma/mas/ platdata/filestorage/announcements/provisioned. The file can then be accessed client applications by using the path / Announcements/provisioned/ninety-nine.wav. Configuring Avaya ACE servers as SIP Entities Provision the Avaya ACE server for client applications as SIP Entities with Session Manager. 1. In the DNS, assign a domain name to the Avaya ACE server. 2. In System Manager define a SIP Entity for the domain name defined in Step 1. Installing Avaya Agile Communication Environment Foundation Toolkit March

18 Installing Foundation Toolkit a. Click Routing > SIP Entities. b. Click New. c. On the SIP Entity Details page, create a new SIP Entity as follows: In FQDN or IP Address, enter the domain name defined in Step 1. Set Type to Other. For information on the remaining fields on this page, see the System Manager online Help system. d. Click Commit to save the new SIP Entity. 3. In System Manager define a trusted Entity Link between Session Manager and the Avaya ACE server. a. Click Routing > Entity Links. b. Click New. c. On the Entity Links page, create a new Entity Link as follows: In Name, enter a name for the link. Set SIP Entity 1 to a suitable instance of Session Manager. Set Protocol to TLS. Set Port to the Session Manager TLS port. Set SIP Entity 2 to the SIP Entity defined in Step 2. Set Port to the Foundation Toolkit Secure SIP port (5063). Select Trusted. For information on the remaining fields on this page, see the System Manager online Help system. d. Click Commit to save the new Entity Link. Communication Manager configuration Communication Manager Direct IP-IP Audio Connections must be disabled for signalling groups using Foundation Toolkit services. Note: This configuration is only required if Communication Manager participates in Foundation Toolkit call flows. This configuration procedure requires experience of configuring Communication Manager. 18 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

19 Disabling HTTP access 1. Log in to the Communication Manager server, for example using SSH or PuTTY. 2. Enter sat to start the Communication Manager command-line sat utility. 3. Enter change signaling-group xxx where xxx is the number of a signalling group using Foundation Toolkit services. 4. Set Direct IP-IP Audio Connections to n. 5. Press F3 to save the changes. 6. Enter save tr to save the translations. Disabling HTTP access 1. Log on to the WebSphere Integrated Solutions Console by navigating to the following URI: where aceserver is the host name or IP address of the Avaya ACE server. Log on using the user name admin and the WebSphere primary administrative account password set during Foundation Toolkit installation. 2. Click Servers > Server Types > WebSphere application servers. 3. Click AAFT. 4. Click Web Container Settings > Web container transport chains. 5. Click HttpQueueInboundDefault. 6. HTTP access is enabled by default. Click to clear the Enabled check box. HTTP access by client applications to the Foundation Runtime Services is now disabled. Client application can now only connect using HTTPS. Verifying installation After installation is complete, verify the success of the installation by running the sample applications in your newly installed Foundation Toolkit environment. For more Installing Avaya Agile Communication Environment Foundation Toolkit March

20 Installing Foundation Toolkit information, see the Avaya Agile Communication Environment Foundation Toolkit Sample Web Applications Guide and the Avaya Agile Communication Environment Foundation Toolkit Sample Java SE Applications Guide. Uninstalling Foundation Toolkit Run the uninstallation script: /opt/avaya/ace-xxx/install/uninstall_aaft.sh, where xxx is a version number. Once the installation has completed, the script displays the message COMPLETED. Foundation Toolkit installation parameter descriptions Field WebSphere primary administrative account password Description Mandatory The administrative password for the WebSphere server hosting the Foundation Runtime Services. Note: Make a note of the password as it is required by the Foundation Toolkit start- and stop-scripts, and by the WebSphere administrative interface. Media Server SIP URI The SIP URI for the media server used by the Foundation Toolkit. For example: sip:msml@ms.example.com: 5060;transport=tcp If media services are not required by client applications, then Media Server SIP URI can be left blank. Note: The address part of the URI can use a host name or IP address. Session Manager Address Mandatory The address for the primary Session Manager for the Avaya ACE server. This is a fragment of a full SIP URI, excluding the 20 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

21 Foundation Toolkit installation parameter descriptions Field System Manager Hostname System Manager Certificate Enrollment Password Host name for SSL certificate Description part up to delimiter (for example, this part of the URI is not included: sip:username@"). For example: sm.example.com:15060;transport=tls Note: The address string can use a host name or IP address. This should be the address of the Session Manager Security Module. Mandatory The host name or IP address of the server hosting System Manager. Mandatory The trust management enrollment password set in System Manager. Mandatory The IP address or host name of the server hosting the Avaya ACE server. This host name is used by client applications to establish a secure connection. Installing Avaya Agile Communication Environment Foundation Toolkit March

22 Installing Foundation Toolkit 22 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

23 Chapter 3: Troubleshooting Client application encounters media server-related exceptions A client application encounters media server-related exceptions when attempting to access Foundation Toolkit media services. This can be an application error, a Foundation Toolkit configuration error, or the media server can be unavailable. Related topics: Connecting to the media server on page 23 Connecting to the media server 1. Verify the configuration of Foundation Toolkit: a. Check for incorrect Foundation Toolkit configuration values in the Avaya Agile Communication Environment Web GUI by clicking Configuration > Avaya ACE Foundation Toolkit. If the media server configuration is incorrect, enter correct values. For more information, see Installation checklist on page 12. b. If no value is set for Media Server SIP URI in the Foundation Toolkit configuration, this indicates that the Foundation Toolkit installation is not intended to support media operations. The application encountering media server errors cannot run on this installation of Foundation Toolkit. Alternately, Foundation Toolkit must be reinstalled with a valid media server SIP URI. 2. If the configuration of Foundation Toolkit is correct, check whether the media server is running. If necessary, restart the media server. For more information, see Installing Avaya Media Server on page 15. Installing Avaya Agile Communication Environment Foundation Toolkit March

24 Troubleshooting No connection to Session Manager There is no connection to Session Manager, so no SIP traffic is received and registrations cannot be made through the Registration Service. Related topics: Connecting to Session Manager on page 24 Connecting to Session Manager 1. Verify that Session Manager is running. For example, ping the Session Manager server. For more information, see the Session Manager documentation. Note: Foundation Toolkit periodically pings the Session Manager server. Failures to respond to the pings are recorded in the Foundation Toolkit logs, found in the directory opt/ibm/websphere/appserver/profiles/appsrv01/logs/aaft on the Avaya ACE server. If Session Manager is not running, restart Session Manager. For more information, see the Session Manager documentation. 2. Check for incorrect Foundation Toolkit configuration values in the Avaya Agile Communication Environment Web GUI by clicking Configuration > Avaya ACE Foundation Toolkit. If an incorrect address is configured for Session Manager, enter a correct value. For more information, see Foundation Toolkit installation parameter descriptions on page 20. Client applications cannot connect to Foundation Toolkit Client applications cannot establish a connection with the Foundation Toolkit server, with the client application receiving exceptions related to the unavailability of the Foundation Toolkit or to trust issues. 24 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

25 Client applications cannot connect to Foundation Toolkit Related topics: Foundation Toolkit server unavailable on page 25 Trust management errors on page 25 Foundation Toolkit server unavailable 1. Verify that the Foundation Toolkit server is unavailable. The following methods can be used to investigate the state of the server: a. Ping the server. b. Log in to the Foundation Toolkit server using SSH or PuTTY and check whether the AAFT process is running. c. In System Manager, check that the Entity link between Foundation Toolkit and Session Manager is functioning. For more information, see Configuring Avaya ACE servers as SIP Entities on page Restart the Foundation Toolkit server. a. Reboot the Foundation Toolkit server if necessary. b. Log in to the Foundation Toolkit server using SSH or PuTTY and open the directory: opt/ibm/websphere/appserver/profiles/appsrv01/bin c. Execute the following command: startserver.sh AAFT Trust management errors 1. Verify the cause of the issue: Examine the log files in following directory on the Avaya ACE server for log messages related to SSL or trust management issues: opt/ibm/websphere/appserver/profiles/appsrv01/logs/aaft 2. Reinstall Foundation Toolkit. For more information, see Installation checklist on page 12. Installing Avaya Agile Communication Environment Foundation Toolkit March

26 Troubleshooting ServletExceptions during logging ServletExceptions are encountered during logging actions. The exceptions can be seen in the catalina.log file in the Tomcat installation on the Avaya ACE server. Related topics: Run AAFT process with root user permissions on page 26 Run AAFT process with root user permissions This problem can occur when the Foundation Toolkit is installed by a user with root permissions but the AAFT process is run by a user with fewer permissions. Restart the AAFT process as a user with root permissions. a. Log in to the Foundation Toolkit server using SSH or PuTTY and open the directory: Ensure that you log in as a root user. opt/ibm/websphere/appserver/profiles/appsrv01/bin b. Execute the following command: stopserver.sh AAFT c. Execute the following command: startserver.sh AAFT Unknown WebSphere primary administrative account password The WebSphere primary administrative account password is not known to the user monitoring or configuring the Foundation Toolkit installation. If the password is not known, WebSphere cannot be administered, and the scripts to start and stop the Foundation Toolkit process cannot be executed. The WebSphere administration password is set during installation of Foundation Toolkit, and a note should be taken of this value at that time. Related topics: Resetting the WebSphere administrative password on page Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

27 Unknown WebSphere primary administrative account password Resetting the WebSphere administrative password Reinstall Foundation Toolkit. For more information, see Installation checklist on page 12. Installing Avaya Agile Communication Environment Foundation Toolkit March

28 Troubleshooting 28 Installing Avaya Agile Communication Environment Foundation Toolkit March 2011

29 Index A application...7, 8 Avaya ACE...7 Avaya ACE Foundation Toolkit...7 Avaya Agile Communication Environment...7 Avaya Aura...7 Avaya Aura Communication Manager...11 Avaya Aura Foundation Toolkit client-side library...11 network environment...11 server...11 Avaya Aura Session Manager...7, 11 Avaya Aura System Manager...11 Avaya Media Server...11 B barring...8 blocking...8 C call barring...8 blocking...8 conferencing...7, 8 recording...8 redirection...8 screening...8 sequencing...7 client-side libraries...11 D Delegate Applications provisioning...17 E Endpoint Applications provisioning...17 environment...11 F Foundation Runtime Services...7 Foundation SDK...8 Foundation Toolkit...7 Foundation Toolkit API...8 Foundation Toolkit client-side libraries...8 H HTTPS...9 I installation verifying...19 installation overview...11 interactive voice response (IVR)...8 interfaces...8 J Java...8 M media...7, 8 N Named Applications provisioning...17 network environment...11 P proxy...7 R recording...8 redirection...8 routing...7 S sample applications...8, 19 Installing Avaya Agile Communication Environment Foundation Toolkit March

30 screening...8 SDK...8 security features...9 Sequenced Applications provisioning...17 server...11 SIP...7, 8 SIP Element...17 T trust Installing Avaya Agile Communication Environment Foundation Toolkit March 2011