Beruflich Dokumente
Kultur Dokumente
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
1 of 32 Telephony_ws
Contents
About this Tutorial.................................................................................................................. 3 Intended Audience.................................................................................................... 3 Prerequisites 3 Chapter 1: Chapter 2: 2.1 2.2 2.3 2.4 2.5 2.6 2.6.1 2.6.2 2.6.3 2.6.4 2.6.5 Chapter 3: 3.1 3.2 Chapter 4: 4.1 4.2 4.3 4.3.1 4.3.2 4.3.3 Telephony Web Service ................................................................................... 4 Getting Started ................................................................................................. 5 Network Architecture.................................................................................... 5 Equipment and Software.............................................................................. 6 Checking for Web Service Availability on AE Server ................................... 7 Third Party Requirements ............................................................................ 7 Checking the Access to Telephony Web Service WSDL File...................... 8 Creating TSAPI Link in AE Server ............................................................... 9 Configuring the Avaya Communication Manager System ........................... 9 Configuring Phone Extensions................................................................... 10 Creating CT User in AE Server .................................................................. 11 Setting up the TSAPI Link on the Avaya AE Server .................................. 13 Testing the Configuration using the TSAPI Test Utility ............................ 19 Telephony Web Service Dialog Designer Application.................................... 21 Developing the Application using Dialog Designer .................................... 21 Exporting the Dialog Designer Application................................................. 25 Testing the Application ................................................................................... 29 Adding the Phone Extensions to Devices List in AE Server ..................... 29 Testing the makeCall Operation on Avaya Application Simulator............ 29 Exception and Error Handling .................................................................... 30 Error (Compile time)................................................................................... 30 Handling Exceptions .................................................................................. 30 Using Try Catch Nodes for Exception Handling......................................... 30
References .......................................................................................................................... 31
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
2 of 32 Telephony_ws
After completing this tutorial, the developer will be able to use Telephony Web Service in a Speech Application created using Avaya Dialog Designer. The developers will also gain knowledge on adding and using a web service in a Dialog Designer Speech Application.
Intended Audience
This Tutorial is intended for application developers who want to develop Telephony Web Service Applications using Avaya Dialog Designer. It is not required to understand CSTA concepts or Avaya Communication Manager Features and concepts, but they both might be helpful. For those new to Avaya Communication Manager, a course can be taken from Avaya University (http://www.avaya.com/learning) to learn more about Communication Manager and its features. It is recommended to start with the Avaya Communication Manager Overview course (course ID: AVA00383WEN).
Prerequisites
This tutorial assumes that the developer already knows how to create a simple speech application using the Avaya Dialog Designer (Eclipse IDE) and is familiar with Java language, Telephony concepts, XML and Web service.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
3 of 32 Telephony_ws
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
4 of 32 Telephony_ws
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
5 of 32 Telephony_ws
Table 2: Equipment and Software version information (Development Requirements) Table 3 shows the equipment and software version information used by this tutorial for running the application on Avaya Voice Portal. Equipment Avaya Voice Portal Management System (VPMS) 4.1 Avaya Media Processing Platform (MPP) Apache Tomcat Web Server Avaya AE Server Software Version 4.1.0.0.2501 Version 4.1.0.0.2501 5.5.23 4.1
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
6 of 32 Telephony_ws
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
7 of 32 Telephony_ws
Figure 2: Telephony Service WSDL File Incase the above screen is not visible, Check whether the browser proxy settings are correct. Check whether the AE Server is accessible from the system where application is being developed, ping the server to check this.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
8 of 32 Telephony_ws
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
9 of 32 Telephony_ws
3. Type change ip-services and move to the AE Services Administration page. Under the AE Services Server column enter the machine name assigned to the AE server. Type in a system password and set the value under the Enabled column to y as shown below.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
10 of 32 Telephony_ws
Figure 6: CTI OAM Admin Page SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 11 of 32 Telephony_ws
3. Select UserManagement> Add User Link. Enter the mandatory fields Userid', Common Name, etc marked with a *. In Avaya Role field select userservice.useradmin from the drop down list. In CT User select Yes from the drop down list.
Figure 7: Select CT User and Avaya Role Option 4. Click on Apply to create a new CT user.
Figure 8: Creating CT User SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 12 of 32 Telephony_ws
Figure 9: CTI OAM Admin Page 2. Click on Switch Connections link under Administration as shown below. Type in the name of the CTI-link created on the Avaya Communication Manager as shown in section Configuring the Avaya Communication Manager Systems - Step 2 and click the Add Connection button.
Figure 10: Add CTI-Link SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 13 of 32 Telephony_ws
3. Type the AE Server password (described in section Configuring the Avaya Communication Manager System Step 3) in the Switch Password and Confirm Switch Password fields as shown below and click the Apply button.
Figure 11: Set Password 4. Click on the Edit CLAN IPs button to enter the IP address of the CLAN card in the Avaya Communication Manager system.
Figure 12: Edit CLAN IP Address SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 14 of 32 Telephony_ws
5. Click on TSAPI Links under CTI Link Admin and click on Add Link.
Figure 13: Add TSAPI Link 6. Select the Switch Connection setting from the drop down box. Select the same Switch Connection name configured in the steps above. Select the Switch CTI Link Number from the drop down box. This should correspond to the CTI-Link number assigned to the switch as shown in section Configuring the Avaya Communication Manager System - Step 2 . Select Unencrypted from the Security drop-down if using unencrypted Tlink. Click on the Apply Changes button to proceed.
Figure 14: Edit TSAPI Link SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 15 of 32 Telephony_ws
7. Click on the Apply Button to proceed and use the Service Controller page to restart the TSAPI server for changes to take effect.
Figure 15: Apply Changes to TSAPI Link 8. Access the Switch Conn Summary page under Status and control as shown below. View the switch connection details and verify that the Conn State is Talking.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
16 of 32 Telephony_ws
9. Click on the Tlinks link under Security Database and ensure that the name for the configured Tlink is seen under the TLink Name column below. The second part of this string will contain the switch name used to configure the Tlink.
Figure 17: TLinks Page 10. Click on Devices and ensure that the phone extensions created on the Avaya Communication Manger are listed under the Device ID column. Use the Add Device button to add these extensions and select the Device Type as PHONE.
Figure 18: Devices Page SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 17 of 32 Telephony_ws
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
18 of 32 Telephony_ws
Figure 19: TSAPI Test 2. Select the appropriate TLink Name from the drop down box. Type in a username and password (ensure that this user is a CT user). In the From and To fields type in the extension numbers. These extension numbers should be viewable under the devices page (Step 10 in previous section). Click on the Dial button to dial the extension.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
19 of 32 Telephony_ws
3. The page shown below is seen if the Dial event is successfully completed.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
20 of 32 Telephony_ws
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
21 of 32 Telephony_ws
2. Create a Speech project. Right click on the project and select New. Choose Web Service Operation File as shown below. If Web Service Operation File not visible as shown below, select Other and then select Web Service Operation File from Avaya Speech Development option.
Figure 23: Creating WSOP File 3. Enter appropriate name in the File Name column and enter the Telephony Web Service URL in the WSDL URL column as shown below. In the Authentication drop down select Basic. In the User Name and Password field enter the CT user name and password. Then click on Load Button, if the load is successful, a drop down list containing the operation supported by the web service is displayed. Select makeCall(string, string) operation. Then click Next button.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
22 of 32 Telephony_ws
4. Click on Auto Create to automatically create the variables originatingExtension and destinationNumber. Alternatively variables can also be created by dragging a simple variable in flow/project.variables pane. Then corresponding variables can be selected from the Variable Name drop down list. Click on Next to proceed.
Figure 25: Mapping Input Variables 5. The next screen is for mapping output parameters. But since this web service does not return anything, click on Finish.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
23 of 32 Telephony_ws
6. To maintain a session, the sessionID parameter needs to be added in the SOAP Headers. To add the sessionID parameter click on Add button, enter the name sessionID in the Name field. Create a simple variable sessionidentifier using Flow -> project variables palette. Select the created variable from the variable drop down list. For getting new sessionID, select In from the drop down list of Direction column. And to reuse the existing sessionID, select Out from the same drop down list. Save the WSOP file.
Figure 27: Adding sessionID 7. Select application flow view and drag the Data node from the Application Items section in the palette as shown below. Rename the node.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
24 of 32 Telephony_ws
8. Double click on the Data node to open it. Drag the Web Service node from the palette and select the WSOP file that was created earlier from the drop down list in properties window. Save the settings.
Figure 29: Editing MakeCall Data Node 9. Similarly the TransferCall, DisconnectCall, AnswerCall operations from Telephony Web Service can be used in any Speech Application. The corresponding operation needs to be selected while creating the WSOP file.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
25 of 32 Telephony_ws
Figure 31: Exporting Dialog Designer Speech Project 3. Select the destination directory where the War file needs to be saved. Click on Next.
Figure 32: Specify Destination Directory SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 26 of 32 Telephony_ws
4. Select the platform-specific details, i.e. if deploying on Voice Portal, select Voice Portal from the drop down list. Select the Servlet container from the drop down list that will be used for deploying the War file. Select the Speech Recognizer. Click on Next.
Figure 33: Select Runtime Platform Settings 5. Select the options as per the screen shown below. If application needs to be rebuilt before deploying select the Rebuild applications check box. If Trace logs are required then deselect the Tracing check box. Click Next to proceed.
Figure 34: Export Dialog Designer Project SJ; Reviewed; SPOC 1/28/2008 Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved. 27 of 32 Telephony_ws
Figure 35: Web Application Descriptor If the export operation is successful the war file gets created in the destination directory specified in step 3.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
28 of 32 Telephony_ws
Figure 36: Testing the Application 3. Click on Run Application to run the application. If the makeCall operation succeeds, a call gets initiated from the original extension to destination extension. In case of errors refer to error handling section to know how to debug the errors. 4. On similar lines the remaining Telephony Web Service requests can be tested.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
29 of 32 Telephony_ws
Figure 37: Exception Handling using Try Catch Nodes 2. The error code and error message of the last generated exception get stored in ddLastException variable. 3. Individual exceptions can be caught by adding the specific exceptions in Exceptions column of Catch nodes properties.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
30 of 32 Telephony_ws
References
While planning, developing, deploying, or troubleshooting the application, reference to other documents may be required, these references are listed below. Dialog Designer Documents [1] Getting started with Dialog Designer Available at: Avaya Dialog Designer 4.1 CD-ROM (which includes the software). Avaya Dialog Designer 4.1 as CD-ROM image downloadable from the Avaya DevConnect web site at: http://www.avaya.com/devconnect. [2] Avaya Dialog Designer Developers Guide Viewable from within Dialog Designer. In Eclipse, click Help (menu) > Help Contents > Dialog Designer documentation. Application Enablement Services documents [3] Avaya MultiVantage Application Enablement Services Overview (02-300360) [4] Avaya MultiVantage Application Enablement Services Installation Guide Software Only Offer (02-300355) All these documents are available online on the Avaya DevConnect Web Site: http://www.avaya.com/devconnect. Communication Manager Documents Since these web services gives programmable access to Avaya Communication Manager Features, the reference documents about that system might be required. Those documents are found on the Avaya DevConnect Web Site: http://www.avaya.com/devconnect. [5] Administrators Guide for Avaya Communication Manager (03-300509) Voice Portal Documents [6] Configuring Avaya Voice Portal with Avaya Communication Manager and Designing a Sample Speech Application using Avaya Dialog Designer Issue 1.0.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
31 of 32 Telephony_ws
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 this tutorial is subject to change without notice. The configurations, technical data, and recommendations provided in this tutorial is believed to be accurate and dependable, but is presented without express or implied warranty. Users are responsible for their application of any products specified in this tutorial. Please e-mail any questions or comments pertaining to this tutorial along with the full title name and filename, located in the lower right corner, directly to the Avaya DevConnect Program at devconnect@avaya.com.
Solution & Interoperability Test Lab Tutorial 2008 Avaya Inc. All Rights Reserved.
32 of 32 Telephony_ws