Application Enablement Services Documentation Road Map

Transcription

1 Application Enablement Services Documentation Road Map Use the Avaya MultiVantage Application Enablement Services Documentation Road Map to locate the Application Enablement Services documents and to get a basic understanding of how to use them. The Application Enablement Services Documentation Road Map includes the following topics Where to find the documents on page 2 - Application Enablement Services Document list on page 3 How to use the documents on page 5 - Planners on page 5 If you use the Application Enablement Services Software-Only Offer on page 5 If you use the Application Enablement Services Bundled Server Offer on page 5 - Installers and administrators -- Software-Only Offer on page 6 - Installers and administrators -- Bundled Server Offer on page 6 - Administrators and programmers - migration issues on page 6 If you are migrating from Communication Manager API 2.1 on page 6 If you are migrating from Avaya Computer Telephony on page 7 - Programmers on page 8 Web Services Programmers on page 8 Device, Media, and Call Control API Programmers on page 8 TSAPI Programmers on page 9 CVLAN Programmers on page 10 ASAI Programmers on page Issue 2 June

2 Application Enablement Services Documentation Road Map Where to find the documents Follow these steps to locate the Application Enablement Services documents. 1. From locate the Get Support tab, and click Documentation. Your browser displays the Find Documentation and Downloads by Product Name Web page (the product index page). 2. From the Find Documentation and Downloads by Product Name page, select Application Enablement Services. Your browser displays the Application Enablement Services Web page. 3. Select View All documents. Your browser displays the Application Enablement Services: All Documents page. Note: Note: The Application Enablement Services: All Documents page lists many types of documents. In addition to installation guides, administration guides, and programming guides, this page includes special usage documents and software downloads. These special usage documents such as MIBs (Management Information Base - a document specific to Simple Network Management Protocol), Product Support Notices (PSNs), and software downloads are not described in this documentation road map. 4. Select one of the documents. For example, scroll down the page and select Avaya MultiVantage TM Application Enablement Services Overview. 5. Your browser displays the Application Enablement Services: Overview Web page. 6. Scroll down the page, and locate the Files field. From the Files field, choose either of the following options: Select View PDF, to view a copy of the document in your browser. Select Download, and save the file to your computer. 2 Application Enablement Services Road Map, Release 3.1.1

3 Where to find the documents Application Enablement Services Document list Use the following list to become familiar with the Application Enablement Services (AE Services) installation guides, programming guides, administration guides, and reference guides. Note: The Note: current list of AE Services documents spans Release 3.1 and Release Avaya MultiVantage Application Enablement Services Documentation Road Map, Avaya MultiVantage Application Enablement Services Overview, Avaya MultiVantage Application Enablement Services Installation Guide Software-Only Offer, R 3.1.1, Avaya MultiVantage Application Enablement Services Installation and Upgrade Guide for a Bundled Server, R3.1.1, Avaya MultiVantage Application Enablement Services Administration and Maintenance Guide, R Avaya MultiVantage Application Enablement Services OAM Help (Online, packaged with Application Enablement Services software and not available on the Web) Avaya MultiVantage Application Enablement TSAPI Exerciser Help (a.pdf document, packaged with the AE Services TSAPI Client SDK software and not available on the Web) Avaya MultiVantage Application Enablement Services Web Services Programmer Guide, Avaya MultiVantage Application Enablement Services Device, Media, and Call Control XML Programmer Reference (Web-based document with no document number) Avaya MultiVantage Application Enablement Services Device, Media, and Call Control XML Programmer Guide, R3.1.1, Avaya MultiVantage Application Enablement Services Device, Media, and Call Control Java Programmer Reference (Web-based document with no document number) Avaya MultiVantage Application Enablement Services Device, Media, and Call Control Java Programmer Guide, R3.1.1, Avaya MultiVantage Application Enablement Services TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide, R3.1.0, Avaya MultiVantage Application Enablement Services TSAPI for Avaya Communication Manager Programmer Reference, R3.1.0, Avaya MultiVantage Application Enablement Services TSAPI Programmer s Reference, Release 3.1.0, Avaya MultiVantage Application Enablement Services CVLAN Programmer's Reference, R3.1.0, Issue 2 June

4 Application Enablement Services Documentation Road Map Avaya MultiVantage Application Enablement Services JTAPI Programmer's Reference, R3.1.0, (Web-based document with no document number) Avaya MultiVantage Application Enablement Services ASAI Technical Reference, R3.1.0, Avaya MultiVantage Application Enablement Services ASAI Protocol Reference, R3.1.0, Application Enablement Services Road Map, Release 3.1.1

5 How to use the documents How to use the documents The Application Enablement Services documentation list is extensive, but It is very unlikely that anyone would need to read all of the documents. Here are some guidelines for using the documents based on your role within your organization. Planners Use the following documents if you are involved with planning an Application Enablement Services Server (AE Server) installation. Avaya MultiVantage Application Enablement Services Overview, Avaya MultiVantage Application Enablement Services Road Map, Depending on the scope of your planning, you might want to consult additional documents for more information. The following sections provide information about using additional documents for implementing Application Enablement Services. If you use the Application Enablement Services Software-Only Offer If you use the Application Enablement Services Bundled Server Offer Administrators and programmers - migration issues Programmers If you use the Application Enablement Services Software-Only Offer If you use the Application Enablement Services Software-Only offer, read the following document to become familiar with the installation and set up process. Avaya MultiVantage Application Enablement Services Installation Guide Software-Only Offer, If you use the Application Enablement Services Bundled Server Offer If you use the Application Enablement Services Bundled Server offer, installation tasks are performed by Avaya Services or an Independent System Vendor (ISV), and you are not directly involved with installation. If you want to understand how the Application Enablement Services Bundled Server is set up, see the Avaya MultiVantage Application Enablement Services Installation and Upgrade Guide for a Bundled Server, Issue 2 June

6 Application Enablement Services Documentation Road Map Installers and administrators -- Software-Only Offer To install the software and get the Application Enablement Services Server to an operational state, use the following documents. Avaya MultiVantage Application Enablement Services Installation Guide Software-Only Offer, Avaya MultiVantage Application Enablement Services Administration and Maintenance Guide, Avaya MultiVantage Application Enablement Services OAM Help Installers and administrators -- Bundled Server Offer To install the software and get the Application Enablement Services Server to an operational state, use the following documents. Avaya MultiVantage Application Enablement Services Installation and Upgrade Guide for a Bundled Server, Avaya MultiVantage Application Enablement Services Administration and Maintenance Guide, Avaya MultiVantage Application Enablement Services OAM Help Administrators and programmers - migration issues Use this section if you are involved with migrating AE Services based applications. Information intended for programmers is specifically noted. If you are migrating from Communication Manager API 2.1 Application Enablement Services provides a migration path for Communication Manger API 2.1. Application Enablement Services Release Device, Media, and Call Control provides the same functionality as Communication Manager API 2.1, but there are some differences that affect programming and administration. For more information, see Chapter 5 of the Avaya MultiVantage Application Enablement Services Overview, Application Enablement Services Road Map, Release 3.1.1

7 How to use the documents If you are migrating from Avaya Computer Telephony If you are migrating from Avaya Computer Telephony, Release 1.3, the Avaya MultiVantage Application Enablement Services Administration and Maintenance Guide, is your primary resource. Here are some pointers for using the document. Read Chapter 4 to become familiar with client-specific changes and migration issues for the TSAPI Service. Tip: Tip: If you plan to migrate your Avaya Computer Telephony Security Database to the Application Enablement Services Security Database, Application Enablement Services provides the Import SDB capability. If you plan to use Windows Active Directory Services or Linux instead of the Application Enablement Services User Service for user authentication, see Chapter 6. If you plan to use Windows Active Directory services for user authentication, and you plan to use the Application Enablement Services SDB for user authorization, see Appendix B. If you are installing TSAPI, JTAPI, and CVLAN clients and SDKs To install AE Services TSAPI, JTAPI, and CVLAN clients, refer to the Avaya MultiVantage Application Enablement Services TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide, Release 3.1.0, Note: Note: The AE Services TSAPI, JTAPI, and CVLAN documents, Release 3.1.0, are client-specific documents. They replace the Avaya Computer Telephony documents Issue 2 June

8 Application Enablement Services Documentation Road Map Programmers Application Enablement Services provides Software Development Kits (SDKs) and programming documents for developing applications. For general information about the capabilities of the APIs, see the Avaya MultiVantage Application Enablement Services Overview, Web Services Programmers Application Enablement Services provides the following Web Services. System Management Service (System Management Service SDK) Telephony Web Service (Telephony Web Service SDK) User Service (User Service SDK) For information about Services, see the following document. Avaya MultiVantage Application Enablement Services Web Services Programmer Guide ( ) Device, Media, and Call Control API Programmers Application Enablement Services provides Device, Media, and Call Control programmers with tools for learning to use the APIs as well as SDKs for implementing the APIs. (Device, Media, and Call Control was formerly known as Communication Manager API.) If you want to learn about the Device, Media, and Call Control API, you can run the sample application described in Appendix A of the Avaya MultiVantage Application Enablement Services Installation Guide. If you are ready to program to either API (Java or XML) see the following documents and the corresponding SDK. - Avaya MultiVantage Application Enablement Services Device, Media, and Call Control XML Programmer Guide, (Device, Media, and Call Control XML SDK) - Avaya MultiVantage Application Enablement Services Device, Media, and Call Control XML Programmer Reference (Device, Media, and Call Control XML SDK) - Avaya MultiVantage Application Enablement Services Device, Media, and Call Control Java Programmer Guide, (Device, Media, and Call Control API Java SDK) - Avaya MultiVantage Application Enablement Services Device, Media, and Call Control Java Programmer Reference (Device, Media, and Call Control API Java SDK) 8 Application Enablement Services Road Map, Release 3.1.1

9 How to use the documents TSAPI Programmers If you program to TSAPI, use the following documents to develop or maintain your applications. Avaya MultiVantage Application Enablement Services TSAPI for Communication Manager Programmer s Reference, Release 3.1.0, Use this document as your primary reference for TSAPI applications. It documents all third party call control services, including Private Data Services, provided by Avaya Communication Manager. Private Data Services allow you to take advantage of the extended functionality of Communication Manager services. - For information about installing the TSAPI clients and SDKs, see the Avaya MultiVantage Application Enablement Services TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide, Release 3.1.0, Avaya MultiVantage Application Enablement Services TSAPI Programmer s Reference, This document describes the Telephony Services API, which is based on ECMA CSTA Standards 179 and 180. The TSAPI Programmer s Reference is required only if you need to learn the fundamental principles of TSAPI. If you are developing or maintaining TSAPI applications, and you are familiar with TSAPI, the TSAPI for Avaya Communication Manager Programmer s Reference, Release 3.1.0, is your primary reference. JTAPI Programmers If you program to JTAPI, use the following document to develop or maintain your applications. Avaya MultiVantage Application Enablement Services JTAPI Programmer s Reference (an HTML document). Use this document as your primary reference for JTAPI applications. It documents all call control services, including Private Data Services, provided by Avaya Communication Manager. Private Data Services allow you to take advantage of the extended functionality of Communication Manager services. - For information about installing the JTAPI client and SDK, see the Avaya MultiVantage Application Enablement Services TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide, Release 3.1.0, Issue 2 June

10 Application Enablement Services Documentation Road Map CVLAN Programmers If you program to the CVLAN API (which is an implementation of the ASAI protocol), use following documents. Avaya MultiVantage Application Enablement Services CVLAN Programmer s Reference, Release 3.1.0, Use this document as your primary reference for CVLAN applications. It documents all call control services provided by Avaya Communication Manager, which are based on the ASAI protocol. - For information about installing the CVLAN Client/SDK, see the Avaya MultiVantage Application Enablement Services TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide, Release 3.1.0, Avaya MultiVantage Application Enablement Services ASAI Technical Reference, Release 3.1.0, The CVLAN call control capabilities are based on the capabilities described in the ASAI Technical Reference. When a greater level of detail is required for working with these capabilities programmers can consult the ASAI Technical Reference. Avaya MultiVantage Application Enablement Services ASAI Protocol Reference, Release 3.1.0, CVLAN uses the ASAI Protocol. When a greater level of detail is required for working with information elements and the layout of ASAI messages, programmers can consult the ASAI Technical Reference ASAI Programmers If you program directly to the ASAI protocol, use the following documents as your primary reference for ASAI applications. Avaya MultiVantage Application Enablement Services ASAI Technical Reference, Release 3.1.0, The ASAI Technical Reference provides technical descriptions of ASAI third party call control capabilities. Avaya MultiVantage Application Enablement Services ASAI Protocol Reference, Release 3.1.0, The ASAI Protocol Reference provides byte-level descriptions of ASAI messages. 10 Application Enablement Services Road Map, Release 3.1.1