Abstract. Avaya Solution & Interoperability Test Lab

Transcription

1 Avaya Solution & Interoperability Test Lab Application Notes for Packaging and Deploying an Avaya Communications Process Manager SDK Sample Web Application on an IBM WebSphere Application Server Issue 1.0 Abstract These Application Notes describe the steps required to package and deploy an Avaya Communications Process Manager (CPM) SDK sample web application (clientsdk-webui) on an IBM WebSphere Application Server. IBM WebSphere Application Server is a Java 2 Enterprise Edition (J2EE) and Web services technology-based application platform. For these Application Notes, clientsdk-webui Communications Process Manager web client application available in the CPM SDK was deployed to the IBM WebSphere Application Server. This client application was used to verify the Avaya CPM Simple Object Access Protocol (SOAP) web services interaction between the Avaya CPM and the IBM WebSphere Application Server (WAS) platform. The sample configuration used to validate the integration consists of Avaya Communication Manager running on an Avaya S8700 Server with a G650 Media Gateway, Avaya SIP Enablement Services, Avaya Voice Portal, Nuance Text-to-Speech server, Avaya Meeting Exchange Express, Avaya Communications Process Manager, and the IBM WebSphere Application Server. 1 of 33

2 1. Introduction These Application Notes describe the steps required to package and deploy Avaya Communications Process Manager clientsdk-webui web application on an IBM WebSphere Application Server. IBM WebSphere Application Server is a Java 2 Enterprise Edition (J2EE) and Web services technology-based application platform. For these Application Notes, clientsdk-webui web client application available in the Avaya CPM SDK was compiled and deployed to the IBM WebSphere Application Server. This web client application was used to verify the CPM SOAP Web services interaction between the Avaya CPM and IBM WebSphere Application Server platform. The clientsdk-webui web client application project was written in Java code and is generic to all platforms. These Application Notes illustrate how to compile and deploy the clientsdk-webui web client application to the IBM WebSphere Application Server. The clientsdk-webui sample web client application supports the following Avaya Communications Enabled Business Process web services: Advisory: This web client application initiates an outbound advisory request to a list of recipients for them to acknowledge receipt of the notification. Notify and Respond: This web client application initiates an outbound notification with a set of questions to a list of recipients and waits for them to respond to the notification. Notify and Conference: This web client application initiates an outbound notification to a list of recipients. When a notified user answers the phone, the service provides contextual information about the exception conference and asks if the caller wants to join the conference. Find and Call: This web client application uses a recipient list to create either a twoparty call or an on demand conference. For detailed information on the clientsdk-webui sample Avaya SDK web client application refer to [7] in the Additional References section. For these Application Notes, the Avaya CPM SDK web client application was used to verify the interoperability between the IBM WebSphere Application Server and the Avaya CPM via web services. 2 of 33

3 2. Configuration Figure 1 provides an overview of the network used in the sample configuration. This sample configuration consists of Avaya Communication Manager running on Avaya S8700 Server with a G650 Media Gateway, Avaya SIP Enablement Services (SES), Avaya Voice Portal, Nuance Text-to-Speech server, Avaya Meeting Exchange Express, Avaya Communications Process Manager and the IBM WebSphere Application Server. The Avaya 4620 H323 Telephones are registered with Avaya Communication Manager and Avaya SIP Enablement Services (SES), respectively. Avaya SIP telephones are configured as Off-PBX stations (OPS) in Avaya Communication Manager. The Media Processing Platform component in the Avaya Voice Portal system accepts inbound calls and serves as an interactive voice response system for converting CPM text messages to voice. The process of assigning a VXML application and configuring the Media Processing platform is performed through the Voice Portal Management System (VPMS) component. Figure 1: Network Configuration 3 of 33

4 3. Equipment and Software Validated The following equipment and software were used for the sample configuration provided: Equipment & Software Avaya S8700 Server Avaya G650 Media Gateway IPSI CLAN MEDPRO Version Avaya Communication Manager (R014x ) TN2312BP TN799DP TN2302AP Avaya Communications Process Manager Avaya Voice Portal Management System (VPMS) Avaya Media Processing Platform (MPP) Avaya Meeting Exchange Express 1.5 Avaya SIP Enablement Services Nuance RealSpeak Text-to-Speech Server Avaya 4620 H323 Phones 2.5 IBM WebSphere Application Server Microsoft Windows XP Sun Microsystems Java JDK Apache Software Foundation Ant Release Service Pack 2 1.5_0_ Table 1: Equipment/Software List 4 of 33

5 4. Configure Avaya Communications Process Manager In these Application Notes, it is assumed that the Avaya CPM software and the license file have already been previously installed. These Application Notes further assume that Avaya Communication Manager, Avaya SES, Avaya Voice Portal, and Avaya Meeting Exchange Express (as shown in Figure 1) have already been configured and are operational with Avaya CPM. For additional information on these installation tasks, refer to [1], [2], [3], [4], and [5] in the Additional References section. This section describes the steps that are required for adding users to the Avaya Communications Process Manager for use with the clientsdk-webui SDK web application described in later sections. Step 1. On the Avaya CPM server, launch a web browser and enter the URL or IP address of CPM server>/via. When prompted for a user name and password, enter the credentials of the server administrator account. 2. The Communications Process Manager Administration Portal page appears. To add a new user, click Account. 5 of 33

6 Step 3. The Account Home page appears. To create a new user account, for CPM Notifications and Response system, click Create Account. 6 of 33

7 Step 4. The Create Account screen appears. To add a new user to the CPM LDAP directory, click Create Account. Enter the following values: Administrator: To give the user administrator access, select Yes (the default value is set to No). The configuration described in these Application Notes does not require Administrator access for the configured user. CPM User: To make this user a licensed Communications Process Manager user, select Yes. Licensed Communications Process Manager Users can log in to the Communications Process Manager portal and receive notifications. Handle: Enter the user s handle (not shown) ID Number: A unique ID number (e.g., 39101) for the user. Can be an employee number or something similar. This ID number serves as the user's account number and initial PIN. Last Name: Enter User's last name (e.g., Smith). Common Name(s): Communications Process Manager typically uses the first value of the common name in interactions with the user. Phone Number: Telephone number at which Communications Process Manager contacts the user (e.g., sip:39101@cebp-avaya.com.) This is the default telephone number at which Communications Process Manager contacts the user. Advisory Service: Select Yes. Click to Find Service: Select Yes. Notification and Response Service: Select Yes. Notify and Conference Service: Select Yes. Click Save. Note: The Configuration described in these Application Notes uses default values for the remaining fields and hence these fields are not described. For information about a particular field click on the Help link (not shown) from the Create Account page. The two screenshots below display the Create Account screen 7 of 33

8 Step 5. 8 of 33

9 Step Repeat Step 4 to create additional CPM users as necessary. 9 of 33

10 5. Modifying the CPM SDK Web Client Application Note: 1. The below code changes have to be performed in order for the Web Client Application to successfully work when deployed on the IBM WebSphere Application Server. 2. These Application Notes assume that Eclipse Java IDE is installed on a PC as shown in Figure 1 above. Refer to Eclipse documentation for installation and configuration information 1. Step 1. Open Eclipse IDE and click on Window -> Open Perspective -> Java as shown below. 1 The Eclipse Java IDE can be downloaded from 10 of 33

11 2. The screen shot below shows the Java perspective. Click on File -> Import option to import the SDK web application into the workspace. 3. Open the General file and select the Existing Projects into Workspace option as shown below. Click the Next button to continue. 11 of 33

12 4. Use the Browse button to locate the path to the CPM SDK web application (clientsdk-webui). Verify that the correct application is selected under the Projects area. Click on the Finish button to complete the process. 5. Right click on the clientsdk-webui application and select Properties as shown below.. 12 of 33

13 6. Select Java Build Path in the left hand pane and ensure that the build path for the project JAR s is specified correctly. Click the OK button to close this form. Note: Set the build path by clicking the Add Variable button and mapping the variable added to the JAR files in the lib directory (not shown) provided with the clientsdk-webui sample application. 7. Click on Project and select Clean as shown below to build the clientsdk-webui application. Note: It is recommended to select the Build Automatically option. Eclipse will automatically start a build operation if any changes are made to the project. 13 of 33

14 8. Click on the clientsdk-webui application in the Navigator view. Open the directory tree under the src folder (src->com->avaya->cpm->clientsdk->wui) as shown below. Double click on the WebUIContextListener.java file in the Navigator view shown below to open the file in the editor view (not shown). 14 of 33

15 9. Locate the contextinitialized method and insert the lines of code as shown below. Note: The default KeyStore type for IBM WebSphere Application Server 6.1.x is PKCS12 however the application needs to explicitly set this to type JKS to use the default KeyStore provided in the clientsdk-webui tapplication. The following lines of code must be added as shown above to set the keystore and truststore type to Java KeyStore (JKS) type. System.setProperty( javax.net.ssl.truststoretype, jks ); System.setProperty( javax.net.ssl.keystoretype, jks ); 15 of 33

16 5.1. Compiling Avaya CPM SDK Web Client Application This section illustrates how to compile the Avaya CPM SDK web client application. The CPM Client SDK can be downloaded from the following URL: For more information on the clientsdk-webui web client application refer to [7] in the Additional References section Command line compile (using Ant) In this sample configuration, Ant is used to compile the client application source code and build the CPM client application war file 2. Apache Ant is a Java build tool 3. Step 1. Click Start Control Panel System Advanced Environment Variables. In the System variables pane, verify that the JAVA_HOME is properly configured. In these Application Notes, the Java JDK5.0_09 is installed in C:\Program Files\Java\jdk1.5.0_09. The result is shown below. In the System variables pane, click Path Edit and enter the complete path to the <Java install director>/bin folder. Note: If the variable name JAVA_HOME is set as above then the %JAVA_HOME%\bin; string can also be added in the Variable value field. 2. From a PC, download and unzip Apache Ant (e.g., C:\Program Files\apache-ant-1.7.0). 2 The war file shipped with the Avaya CPM SDK can be deployed out of the Box on the IBM WebSphere Application Server. 3 Ant can be downloaded from the following URL: 16 of 33

17 Step 3. Add the ANT_HOME environment variable. Click Start Control Panel System Advanced Environment Variables. In the System variables pane, add ANT_HOME and set the Variable value value to the Ant installation directory. In these Application Notes, ANT is installed under C:\Program Files\apache-ant In the System variables pane, click Path Edit. Enter the complete path to the Ant bin directory as shown in the below screenshot. Note: If the variable name ANT_HOME is set as above then the %ANT_HOME%\bin; string can also be added in the Variable value field. 4. The Avaya CPM SDK web client application comes with the source code. From a PC, unzip the CPM SDK (e.g., C:\CPMSDK2.1). In this sample configuration, the SDK install directory is referred to as <CPM-SDK-DIR>. 17 of 33

18 Step 5. Clean the CPM client build environment. Start a Windows Command Prompt. Change directory to C:\<CPM-SDK-DIR>\javasdk\clientsdk-webui. From the command prompt, run ant clean. Verify that the BUILD SUCCESSFUL message is displayed on the screen. C:\>cd C:\CPMSDK2.1\javasdk\clientsdk-webui C:\CPMSDK2.1\javasdk\clientsdk-webui> C:\CPMSDK2.1\javasdk\clientsdk-webui>ant clean Buildfile: build.xml clean: BUILD SUCCESSFUL 6. The build.xml file contains information that the Java Ant task uses to build the clientsdk-webui web application into the CPMClient-2.1.war archive file. The build.xml file is provided as part of the clientsdk-webui sample application. 7. Build the CPM client build environment. From the command prompt, run ant build. Verify that the BUILD SUCCESSFUL message is displayed on the screen. C:\CPMSDK2.1\javasdk\clientsdk-webui>ant compile Buildfile: build.xml compile: [javac] Compiling 9 source files to C:\CPMSDK2.1\javasdk\clientsdkwebui\bui ld\web-inf\classes [copy] Copying 2 files to C:\CPMSDK2.1\javasdk\clientsdkwebui\build\WEB-IN F\classes BUILD SUCCESSFUL 8. Run ant dist to create the CPM client web application archive (war) file. From the command prompt, run ant dist. Verify that the BUILD SUCCESSFUL message is displayed on the screen. CPMClient-2.1.war file is created in the dist folder under the clientsdk-webui sample application directory. C:\CPMSDK2.1\javasdk\clientsdk-webui>ant dist Buildfile: build.xml BUILD SUCCESSFUL 18 of 33

19 Compiling using Eclipse Java IDE (Optional) In this sample configuration, the Ant build script is invoked from an Eclipse Java IDE to recompile the client application source code and build the CPM client application war file. Step 1. Perform Step 4 in Section above to download CPM SDK and unzip the clientsdk-webui application. 2. Ensure that the lib directory is located under the <CPM SDK install directory>/javasdk folder as shown below. For the configuration used in these Application Notes the lib folder is located under C:\CPMSDK_ \CPMSDK2.1\javasdk 3. Open the lib folder and verify that the Catalina-ant.jar, antlr jar and axis-ant-1.4.jar files are located in this directory. These.jar files are used by Eclipse to invoke Ant and build the.war file. 4. Refer to Steps 1-7 in Section 5 above to import and build the application using Eclipse IDE. 5. Select the build.xml file as shown below. The build.xml file contains information that the Java Ant task uses build.xml file to build the clientsdk-webui web application into the CPMClient- 2.1.war archive file. 19 of 33

20 Step 6. Right click on the build.xml file and select Run As->Ant Build as shown below to start the Ant build process. 20 of 33

21 Step 7. View the Ant build messages under the Console tab as shown below. Ensure that the Compile process completes without any error messages. On completion of the build process the CPMClient-2.1.war file is generated. The default location of the CPMClient-2.1.war file is shown below. Note: The Javadoc warning messages seen below do not affect the functionality of the application and can be ignored. These are generated due to function signatures with void return types. The default CPMClient-2.1.war file build location can be changed by modifying the value of the dist.home property name in the build.xml file. 21 of 33

22 6. Deploy clientsdk-webui Sample Application to IBM WebSphere Application Server These Application Notes assume that the IBM WebSphere Application Server is already installed on Microsoft Windows XP. Refer to [8] in the Additional References section for the IBM WebSphere Application Server installation. This section illustrates how to deploy the CPM SDK client application to the IBM WebSphere Application Server. Step 1. Access the IBM WebSphere First steps application from the Start menu. Start-> IBM WebSphere ->Application ServerV6.1->Profiles->AppSrv01->First Steps 2. On the First steps application page, click on the Administrative console link as shown below. 22 of 33

23 Step 3. The Integrated Solutions Console page is displayed. This page requires a login and an optional password. The login and password are set during installation. The configuration described in these Application Notes uses the default login: admin and no password. Enter admin in the User ID field below and click on the Log in button to continue. 4. View the Welcome page and confirm the IBM WebSphere Application Server version as shown below. 23 of 33

24 Step 5. Click and expand the Applications sub menu and click on the Install New Application link shown below. 6. Enter the full path to the CPMClient-2.1.war file or use the Browse button to set the directory path to the file. Enter any appropriate name in the Context root field for accessing the application. The Context root value used for configuring the clientsdk-webui application described in these Application Notes is CPMClient-2.1.war. Click the Next button to continue. Note: The context root is combined with the defined servlet mapping (from the WAR file) to compose the full URL that users type to access the servlet. 24 of 33

25 Step 7. View the settings displayed on the Select installation options page. These Application Notes use default settings for deploying the clientsdk-webui application described. Scroll to the bottom of the page and click the Next button (not shown) to continue. 8. Proceed towards deploying the application by accepting the default settings in the Map Modules to Server, Map virtual hosts for web modules pages (not shown). Click the Next button (not shown) to proceed forward from one page to the next. View the settings in the Settings page shown below and click the Finish button to finalize configuration settings. 25 of 33

26 Step 9. A status page shown below is displayed if the application is deployed correctly. Click on the Save (directly to the master configuration) link. 26 of 33

27 Step 10. Click on the Enterprise Applications link and view the deployed clientsdk-webui application. Check the box under the Select column and click on the Start button to start the application. 27 of 33

28 7. Verification Steps The following steps may be used to verify proper configuration of Avaya CPM and IBM WebSphere Application Server: Verify that the clientsdk-webui Web Client application is deployed to the IBM WebSphere Application Server. Verify that the CPM Advisory service can be launched and acknowledged by all the recipients. Verify that the CPM Notify and Conference service can be launched and the recipients can join the conference. Verify that the CPM Notify and Respond service can be launched and the recipients can respond to the notification. Verify that the CPM Find and Call service can be launched and can conference the recipients. Verify that Avaya CPM and IBM WebSphere Application Server log files do not show any errors. Step 1. If the application starts successfully then a status message box is shown as seen below. A green icon is displayed under the Application Status column. 28 of 33

29 Step 2. Verify that the CPMClient web application can be started from the IBM WebSphere Application Server. Launch a web browser and enter the URL address of IBM WebSphere Application Server>:9080/CPMClient-2.1.war. Verify that the Communications Process Manager Client screen appears. Note: This Application Notes document uses the default IBM WAS application port Click on the Advisory Service link shown above to view the Advisory Service page. Verify that the recipients acknowledge receipt of the notification. Note: The originator and recipients handles must be pre-configured on the Avaya Communications Process Manager system. 4. Click on the Notify and Conference Service link shown above to view the Notify and Conference Service page. Verify that the Notify and Conference service is successfully completed. 5. Click on the Notify and Respond Service link shown above to view the Notify and Respond Service page. Verify that the Notify and Respond service is successfully completed. 29 of 33

30 Step 6. Click on the Find and Call Service link shown above to view the Find and Call Service page. Verify that the Find and Call service is successfully completed. 7. Launch a web browser and enter the URL or IP address of CPM server>/via to view the debug screen as necessary for verifying the web client application execution. When prompted for a user name and password, enter the credentials of the CPM user account. Click on the Outbox link as shown below and choose the completed option from the Select drop down box to view completed requests. To view the contents of a request, click the subject of the notification under the Subject Column. 8. The following log files are available on the Avaya CPM for troubleshooting purposes. The log files are stored under the /var/log/cpm directory. mail.log nafsvc.log oam.log dcore.log commflow.log advsvc.log b2bua.log account.log via.log platform-licensing.log user-licensing.log cs-tomcat-memorymonitor.log cpm.log complete.log 30 of 33

31 Step 9. The following IBM Websphere log files are located under the <IBM install directory>\appserver\profiles\<profile name>\logs\server1 directory. native_stderr.log native_stdout.log server1.pid startserver.log SystemErr.log trace.log SystemOut.log For the IBM WAS configuration used in this Application Notes document, logs for the IBM WebSphere Application server used in the Application Notes configuration can be found under: C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\logs\server1 10. The level of logging can be modified under the Change Log Details Levels page as shown below. This page can be accessed by clicking on the Troubleshooting->Logs and Trace->Logging and Tracing -> Server1 links. Refer to the online help pages for setting logging levels. Scroll to the bottom of the page and click the Apply button (not shown) to apply changes. The logging level string used for the configuration described in these Application Notes is: *=info: com.ibm.ws.security.*=all: com.ibm.ws.ssl.*=all 31 of 33

32 8. Conclusion As illustrated in these Application Notes, an IBM WebSphere Application Server can be used to successfully interoperate with Avaya Communications Process Manager via web services. 9. Additional References The following documents may be obtained from [1] Administrator Guide for Avaya Communication Manager, Issue 3.1, Doc ID: , February [2] Avaya Communications Process Manager Installation and Configuration Guide Release 2.1, Issue 1, Oct 2007, Document Number [3] Avaya Communications Process Manager Online help for the Administrative Web Portal Release 2.1, Issue 4, Oct 2007, Document Number [4] SIP Enablement Services (SES) Implementation Guide, Issue 4, Doc ID : , May 2007 [5] Avaya Voice Portal 4.1 Documentation Library, Jun-2007 [6] Avaya Meeting Exchange Express Edition Release 1.5 installation and Configuration Guide, Issue 1, Doc ID: , March [7] Avaya Communications Process Manager Release 2.1 Application Programmer s Guide, Issue 1, Doc ID: , Oct The following documents may be obtained from [8] WebSphere Application Server V 6.1: System Management and Configuration. ANT may be downloaded from Java1.5 may be downloaded from Axis 1.4 may be downloaded from Java mail may be downloaded from Java Beans Activation Framework may be downloaded from 32 of 33

33 2008 Avaya Inc. All Rights Reserved. Avaya and the Avaya Logo are trademarks of Avaya Inc. All trademarks identified by and are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks are the property of their respective owners. The information provided in these Application Notes is subject to change without notice. The configurations, technical data, and recommendations provided in these Application Notes are believed to be accurate and dependable, but are presented without express or implied warranty. Users are responsible for their application of any products specified in these Application Notes. Please any questions or comments pertaining to these Application Notes along with the full title and filename, located in the lower right corner, directly to the Avaya Solution & Interoperability Test Lab at 33 of 33