Documente Academic
Documente Profesional
Documente Cultură
Release 8.1.x
Issue 3
November 2019
© 2015-2019, Avaya Inc. YOU DO NOT WISH TO ACCEPT THESE TERMS OF USE, YOU
All Rights Reserved. MUST NOT ACCESS OR USE THE HOSTED SERVICE OR
AUTHORIZE ANYONE TO ACCESS OR USE THE HOSTED
Notice SERVICE.
While reasonable efforts have been made to ensure that the Licenses
information in this document is complete and accurate at the time of
printing, Avaya assumes no liability for any errors. Avaya reserves THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA
the right to make changes and corrections to the information in this WEBSITE, HTTPS://SUPPORT.AVAYA.COM/LICENSEINFO,
document without the obligation to notify any person or organization UNDER THE LINK “AVAYA SOFTWARE LICENSE TERMS (Avaya
of such changes. Products)” OR SUCH SUCCESSOR SITE AS DESIGNATED BY
AVAYA, ARE APPLICABLE TO ANYONE WHO DOWNLOADS,
Documentation disclaimer USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED
“Documentation” means information published in varying mediums FROM AVAYA INC., ANY AVAYA AFFILIATE, OR AN AVAYA
which may include product information, operating instructions and CHANNEL PARTNER (AS APPLICABLE) UNDER A COMMERCIAL
performance specifications that are generally made available to users AGREEMENT WITH AVAYA OR AN AVAYA CHANNEL PARTNER.
of products. Documentation does not include marketing materials. UNLESS OTHERWISE AGREED TO BY AVAYA IN WRITING,
Avaya shall not be responsible for any modifications, additions, or AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE
deletions to the original published version of Documentation unless WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN AVAYA
such modifications, additions, or deletions were performed by or on AFFILIATE OR AN AVAYA CHANNEL PARTNER; AVAYA
the express behalf of Avaya. End User agrees to indemnify and hold RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU
harmless Avaya, Avaya's agents, servants and employees against all AND ANYONE ELSE USING OR SELLING THE SOFTWARE
claims, lawsuits, demands and judgments arising out of, or in WITHOUT A LICENSE. BY INSTALLING, DOWNLOADING OR
connection with, subsequent modifications, additions or deletions to USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO,
this documentation, to the extent made by End User. YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM
YOU ARE INSTALLING, DOWNLOADING OR USING THE
Link disclaimer SOFTWARE (HEREINAFTER REFERRED TO
Avaya is not responsible for the contents or reliability of any linked INTERCHANGEABLY AS “YOU” AND “END USER”), AGREE TO
websites referenced within this site or Documentation provided by THESE TERMS AND CONDITIONS AND CREATE A BINDING
Avaya. Avaya is not responsible for the accuracy of any information, CONTRACT BETWEEN YOU AND AVAYA INC. OR THE
statement or content provided on these sites and does not APPLICABLE AVAYA AFFILIATE (“AVAYA”).
necessarily endorse the products, services, or information described Avaya grants You a license within the scope of the license types
or offered within them. Avaya does not guarantee that these links will described below, with the exception of Heritage Nortel Software, for
work all the time and has no control over the availability of the linked which the scope of the license is detailed below. Where the order
pages. documentation does not expressly identify a license type, the
Warranty applicable license will be a Designated System License as set forth
below in the Designated System(s) License (DS) section as
Avaya provides a limited warranty on Avaya hardware and software. applicable. The applicable number of licenses and units of capacity
Refer to your sales agreement to establish the terms of the limited for which the license is granted will be one (1), unless a different
warranty. In addition, Avaya’s standard warranty language, as well as number of licenses or units of capacity is specified in the
information regarding support for this product while under warranty is documentation or other materials available to You. “Software” means
available to Avaya customers and other parties through the Avaya computer programs in object code, provided by Avaya or an Avaya
Support website: https://support.avaya.com/helpcenter/ Channel Partner, whether as stand-alone products, pre-installed on
getGenericDetails?detailId=C20091120112456651010 under the link hardware products, and any upgrades, updates, patches, bug fixes,
“Warranty & Product Lifecycle” or such successor site as designated or modified versions thereto. “Designated Processor” means a single
by Avaya. Please note that if You acquired the product(s) from an stand-alone computing device. “Server” means a set of Designated
authorized Avaya Channel Partner outside of the United States and Processors that hosts (physically or virtually) a software application
Canada, the warranty is provided to You by said Avaya Channel to be accessed by multiple users. “Instance” means a single copy of
Partner and not by Avaya. the Software executing at a particular time: (i) on one physical
“Hosted Service” means an Avaya hosted service subscription that machine; or (ii) on one deployed software virtual machine (“VM”) or
You acquire from either Avaya or an authorized Avaya Channel similar deployment.
Partner (as applicable) and which is described further in Hosted SAS License types
or other service description documentation regarding the applicable
hosted service. If You purchase a Hosted Service subscription, the Designated System(s) License (DS). End User may install and use
foregoing limited warranty may not apply but You may be entitled to each copy or an Instance of the Software only: 1) on a number of
support services in connection with the Hosted Service as described Designated Processors up to the number indicated in the order; or 2)
further in your service description documents for the applicable up to the number of Instances of the Software as indicated in the
Hosted Service. Contact Avaya or Avaya Channel Partner (as order, Documentation, or as authorized by Avaya in writing. Avaya
applicable) for more information. may require the Designated Processor(s) to be identified in the order
by type, serial number, feature key, Instance, location or other
Hosted Service specific designation, or to be provided by End User to Avaya through
THE FOLLOWING APPLIES ONLY IF YOU PURCHASE AN AVAYA electronic means established by Avaya specifically for this purpose.
HOSTED SERVICE SUBSCRIPTION FROM AVAYA OR AN AVAYA Concurrent User License (CU). End User may install and use the
CHANNEL PARTNER (AS APPLICABLE), THE TERMS OF USE Software on multiple Designated Processors or one or more Servers,
FOR HOSTED SERVICES ARE AVAILABLE ON THE AVAYA so long as only the licensed number of Units are accessing and using
WEBSITE, HTTPS://SUPPORT.AVAYA.COM/LICENSEINFO UNDER the Software at any given time. A “Unit” means the unit on which
THE LINK “Avaya Terms of Use for Hosted Services” OR SUCH Avaya, at its sole discretion, bases the pricing of its licenses and can
SUCCESSOR SITE AS DESIGNATED BY AVAYA, AND ARE be, without limitation, an agent, port or user, an e-mail or voice mail
APPLICABLE TO ANYONE WHO ACCESSES OR USES THE account in the name of a person or corporate function (e.g.,
HOSTED SERVICE. BY ACCESSING OR USING THE HOSTED webmaster or helpdesk), or a directory entry in the administrative
SERVICE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON database utilized by the Software that permits one user to interface
BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE with the Software. Units may be linked to a specific, identified Server
DOING SO (HEREINAFTER REFERRED TO INTERCHANGEABLY or an Instance of the Software.
AS “YOU” AND “END USER”), AGREE TO THE TERMS OF USE. IF
YOU ARE ACCEPTING THE TERMS OF USE ON BEHALF A Shrinkwrap License (SR). You may install and use the Software in
COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT accordance with the terms and conditions of the applicable license
YOU HAVE THE AUTHORITY TO BIND SUCH ENTITY TO THESE agreements, such as “shrinkwrap” or “clickthrough” license
TERMS OF USE. IF YOU DO NOT HAVE SUCH AUTHORITY, OR IF accompanying or applicable to the Software (“Shrinkwrap License”).
Heritage Nortel Software OR HOSTED SERVICE MAY USE THIRD PARTY COMPONENTS
SUBJECT TO THIRD PARTY TERMS AND REQUIRE A SERVICE
“Heritage Nortel Software” means the software that was acquired by PROVIDER TO BE INDEPENDENTLY LICENSED DIRECTLY FROM
Avaya as part of its purchase of the Nortel Enterprise Solutions THE THIRD PARTY SUPPLIER. AN AVAYA CHANNEL PARTNER’S
Business in December 2009. The Heritage Nortel Software is the HOSTING OF AVAYA PRODUCTS MUST BE AUTHORIZED IN
software contained within the list of Heritage Nortel Products located WRITING BY AVAYA AND IF THOSE HOSTED PRODUCTS USE
at https://support.avaya.com/LicenseInfo under the link “Heritage OR EMBED CERTAIN THIRD PARTY SOFTWARE, INCLUDING
Nortel Products” or such successor site as designated by Avaya. For BUT NOT LIMITED TO MICROSOFT SOFTWARE OR CODECS,
Heritage Nortel Software, Avaya grants Customer a license to use THE AVAYA CHANNEL PARTNER IS REQUIRED TO
Heritage Nortel Software provided hereunder solely to the extent of INDEPENDENTLY OBTAIN ANY APPLICABLE LICENSE
the authorized activation or authorized usage level, solely for the AGREEMENTS, AT THE AVAYA CHANNEL PARTNER’S EXPENSE,
purpose specified in the Documentation, and solely as embedded in, DIRECTLY FROM THE APPLICABLE THIRD PARTY SUPPLIER.
for execution on, or for communication with Avaya equipment.
Charges for Heritage Nortel Software may be based on extent of WITH RESPECT TO CODECS, IF THE AVAYA CHANNEL
activation or use authorized as specified in an order or invoice. PARTNER IS HOSTING ANY PRODUCTS THAT USE OR EMBED
THE H.264 CODEC OR H.265 CODEC, THE AVAYA CHANNEL
Copyright PARTNER ACKNOWLEDGES AND AGREES THE AVAYA
Except where expressly stated otherwise, no use should be made of CHANNEL PARTNER IS RESPONSIBLE FOR ANY AND ALL
materials on this site, the Documentation, Software, Hosted Service, RELATED FEES AND/OR ROYALTIES. THE H.264 (AVC) CODEC
or hardware provided by Avaya. All content on this site, the IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE
documentation, Hosted Service, and the product provided by Avaya FOR THE PERSONAL USE OF A CONSUMER OR OTHER USES
including the selection, arrangement and design of the content is IN WHICH IT DOES NOT RECEIVE REMUNERATION TO: (I)
owned either by Avaya or its licensors and is protected by copyright ENCODE VIDEO IN COMPLIANCE WITH THE AVC STANDARD
and other intellectual property laws including the sui generis rights (“AVC VIDEO”) AND/OR (II) DECODE AVC VIDEO THAT WAS
relating to the protection of databases. You may not modify, copy, ENCODED BY A CONSUMER ENGAGED IN A PERSONAL
reproduce, republish, upload, post, transmit or distribute in any way ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER
any content, in whole or in part, including any code and software LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED
unless expressly authorized by Avaya. Unauthorized reproduction, OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL
transmission, dissemination, storage, and or use without the express INFORMATION FOR H.264 (AVC) AND H.265 (HEVC) CODECS
written consent of Avaya can be a criminal, as well as a civil offense MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE HTTP://
under the applicable law. WWW.MPEGLA.COM.
Virtualization Compliance with Laws
The following applies if the product is deployed on a virtual machine. You acknowledge and agree that it is Your responsibility for
Each product has its own ordering code and license types. Unless complying with any applicable laws and regulations, including, but not
otherwise stated, each Instance of a product must be separately limited to laws and regulations related to call recording, data privacy,
licensed and ordered. For example, if the end user customer or intellectual property, trade secret, fraud, and music performance
Avaya Channel Partner would like to install two Instances of the rights, in the country or territory where the Avaya product is used.
same type of products, then two products of that type must be Preventing Toll Fraud
ordered.
“Toll Fraud” is the unauthorized use of your telecommunications
Third Party Components system by an unauthorized party (for example, a person who is not a
“Third Party Components” mean certain software programs or corporate employee, agent, subcontractor, or is not working on your
portions thereof included in the Software or Hosted Service may company's behalf). Be aware that there can be a risk of Toll Fraud
contain software (including open source software) distributed under associated with your system and that, if Toll Fraud occurs, it can
third party agreements (“Third Party Components”), which contain result in substantial additional charges for your telecommunications
terms regarding the rights to use certain portions of the Software services.
(“Third Party Terms”). As required, information regarding distributed Avaya Toll Fraud intervention
Linux OS source code (for those products that have distributed Linux
OS source code) and identifying the copyright holders of the Third If You suspect that You are being victimized by Toll Fraud and You
Party Components and the Third Party Terms that apply is available need technical assistance or support, call Technical Service Center
in the products, Documentation or on Avaya’s website at: https:// Toll Fraud Intervention Hotline at +1-800-643-2353 for the United
support.avaya.com/Copyright or such successor site as designated States and Canada. For additional support telephone numbers, see
by Avaya. The open source software license terms provided as Third the Avaya Support website: https://support.avaya.com or such
Party Terms are consistent with the license rights granted in these successor site as designated by Avaya.
Software License Terms, and may contain additional rights benefiting
Security Vulnerabilities
You, such as modification and distribution of the open source
software. The Third Party Terms shall take precedence over these Information about Avaya’s security support policies can be found in
Software License Terms, solely with respect to the applicable Third the Security Policies and Support section of https://
Party Components to the extent that these Software License Terms support.avaya.com/security.
impose greater restrictions on You than the applicable Third Party
Terms. Suspected Avaya product security vulnerabilities are handled per the
Avaya Product Security Support Flow (https://
The following applies only if the H.264 (AVC) codec is distributed with support.avaya.com/css/P8/documents/100161515).
the product. THIS PRODUCT IS LICENSED UNDER THE AVC
PATENT PORTFOLIO LICENSE FOR THE PERSONAL USE OF A Downloading Documentation
CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE For the most current versions of Documentation, see the Avaya
REMUNERATION TO (i) ENCODE VIDEO IN COMPLIANCE WITH Support website: https://support.avaya.com, or such successor site
THE AVC STANDARD (“AVC VIDEO”) AND/OR (ii) DECODE AVC as designated by Avaya.
VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A
PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO Contact Avaya Support
PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS See the Avaya Support website: https://support.avaya.com for
GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE. product or Hosted Service notices and articles, or to report a problem
ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA, with your Avaya product or Hosted Service. For a list of support
L.L.C. SEE HTTP://WWW.MPEGLA.COM. telephone numbers and contact addresses, go to the Avaya Support
Service Provider website: https://support.avaya.com (or such successor site as
designated by Avaya), scroll to the bottom of the page, and select
THE FOLLOWING APPLIES TO AVAYA CHANNEL PARTNER’S Contact Avaya Support.
HOSTING OF AVAYA PRODUCTS OR SERVICES. THE PRODUCT
Trademarks
The trademarks, logos and service marks (“Marks”) displayed in this
site, the Documentation, Hosted Service(s), and product(s) provided
by Avaya are the registered or unregistered Marks of Avaya, its
affiliates, its licensors, its suppliers, 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, Hosted Service(s) 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.
All non-Avaya trademarks are the property of their respective owners.
Linux® is the registered trademark of Linus Torvalds in the U.S. and
other countries.
Contents
Chapter 1: Introduction............................................................................................................ 8
Purpose.................................................................................................................................. 8
Change history........................................................................................................................ 8
Chapter 2: Overview................................................................................................................. 9
®
Avaya Aura Application Enablement Services overview............................................................ 9
®
Avaya Aura applications deployment offers.............................................................................. 9
Chapter 3: What’s new in Application Enablement Services............................................. 10
New in this release................................................................................................................ 10
New in Application Enablement Services Release 8.1.1..................................................... 10
New in Application Enablement Services Release 8.1........................................................ 11
Application Enablement Services feature matrix....................................................................... 12
Chapter 4: AE Services Product Summary.......................................................................... 14
Introduction........................................................................................................................... 14
DMCC service....................................................................................................................... 14
TSAPI service....................................................................................................................... 15
Web services........................................................................................................................ 15
CVLAN service...................................................................................................................... 16
DLG service.......................................................................................................................... 16
AE Services configuration at a glance..................................................................................... 17
Chapter 5: Network Security and Reliability........................................................................ 18
AE Services security features................................................................................................. 18
Secure application links......................................................................................................... 19
AE Services link resiliency and failover................................................................................... 20
Support for an Enterprise Survivable Server configuration........................................................ 20
Chapter 6: Guidelines for configuring AES.......................................................................... 22
Guidelines and requirements for configuring AE Services......................................................... 22
Configurations that use AEP connections.......................................................................... 23
™ ™
AE Services deployment on Appliance Virtualization Platform on Dell PowerEdge R620......... 23
Guideline for upgrading AE Services to Release 7.x or 8.x on Appliance Virtualization Platform... 24
Chapter 7: AE Services Architecture.................................................................................... 25
AE Services integration with Microsoft Office Communication Servers and Microsoft Lync
Servers................................................................................................................................. 25
AE Services architecture at a glance....................................................................................... 27
Chapter 8: Session Initiation Protocol (SIP)......................................................................... 28
SIP support........................................................................................................................... 28
SIP limitations....................................................................................................................... 29
Chapter 9: AE Services Licensing......................................................................................... 31
AE Services licensing summary.............................................................................................. 31
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 5
Comments on this document? infodev@avaya.com
Contents
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 6
Comments on this document? infodev@avaya.com
Contents
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 7
Comments on this document? infodev@avaya.com
Chapter 1: Introduction
Purpose
This document describes tested characteristics and capabilities of Avaya Aura® Application
Enablement Services, including feature descriptions, interoperability, performance specifications,
security, and licensing requirements.
This document is intended for anyone who wants to gain a high-level understanding of Avaya
Aura® Application Enablement Services features, functions, capacities, and limitations within the
context of solutions and verified reference configurations.
Change history
Issue Date Summary of changes
3 November 2019 Updated the following section:
• SIP support on page 28
2 October 2019 Updated the following sections:
• Application Enablement Services feature matrix on page 12
• API and client compatibility on page 70
• Web services programmers on page 60
1 June 2019 Release 8.1 document
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 8
Comments on this document? infodev@avaya.com
Chapter 2: Overview
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 9
Comments on this document? infodev@avaya.com
Chapter 3: What’s new in Application
Enablement Services
This chapter provides an overview of the new and enhanced features of Application Enablement
Services Release 8.1.x.
For more information about these features and administration, see:
• Administering Avaya Aura® Application Enablement Services
• Deploying Avaya Aura® Application Enablement Services in Virtualized Environment
• Deploying Avaya Aura® Application Enablement Services in a Software-Only Environment
• Deploying Avaya Aura® Application Enablement Services in Infrastructure as a Service
Environment
• Deploying Avaya Aura® Application Enablement Services in Virtual Appliance
• Upgrading Avaya Aura® Application Enablement Services
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 10
Comments on this document? infodev@avaya.com
New in this release
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 11
Comments on this document? infodev@avaya.com
What’s new in Application Enablement Services
• SNMP configuration
Enhancements to the 16-digit extension
With Release 8.1, Avaya Aura® applications extend support for configuration of 16-digit extension
to the following Communication Manager objects.
• hunt groups
Note:
Administration of hunt group with 16-digit group extension and group members.
• coverage answer groups
• ELIN
• abbr dial buttons
• Listed Directory Number
Supported browsers
• Internet Explorer 11
• Mozilla Firefox 65, 66, and 67
Support for Red Hat Enterprise Linux operating system 7.6
With Release 8.1, you can deploy and upgrade Avaya Aura® applications on the Red Hat
Enterprise Linux operating system 7.6.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 12
Comments on this document? infodev@avaya.com
Application Enablement Services feature matrix
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 13
Comments on this document? infodev@avaya.com
Chapter 4: AE Services Product Summary
Introduction
AE Services provides a platform that supports existing contact center application requirements,
along with new, emerging Application Programming Interfaces (APIs). AE Services provides
programs that perform specific functions and provide APIs, protocols, and Web-based interfaces.
A description of each service that is included in AE Services is provided in this chapter. For a high-
level illustration of AE Services see configuration at a glance on page 17.
DMCC service
The Device, Media, and Call Control (DMCC) service provides third-party call control and first-
party call control (device control and media control). The DMCC SDK provides a Java, XML
and .NET API. For more information about the DMCC SDKs, see SDKs on page 43.
• DMCC first-party call control (1PCC)
- DMCC with Device Control can set up a DMCC softphone that gains exclusive or shared
control of a softphone-enabled Communication Manager telephone or extension. A DMCC
softphone is an instance of a phone or extension that is created by AE Services and then
registered on Communication Manager.
- DMCC with Media Control provides the ability to record media from a call into a WAV file or
play a voice announcement or tone that is prerecorded in a WAV file. Media session
control also provides a way for a client application to send and receive TTY characters
over Real-time Transport Protocol (RTP) streams in the form of RFC2833 packets.
Applications can use this capability to implement Voice Carry Over (VCO). The TTY
capability is available in client-media mode only.
• DMCC third-party call control (3PCC)
DMCC with Call Control Services uses the TSAPI service to provide an expanded set of third
party call control capabilities, such as the ability to place calls, create conference calls,
deflect calls, reconnect call, and monitor call control events, just to name a few.
• Routing Services
Routing Services allows applications to request and receive routing instructions for a call.
These instructions, issued by a client routing server application, are based on the incoming
call information provided by Communication Manager.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 14
Comments on this document? infodev@avaya.com
TSAPI service
• System Services
System Services allows applications to request and receive health status of a TSAPI TLink.
System Services also allows applications to request and receive events on the status of
TSAPI CTI (Tlink) connections between the AE Services server and the Communications
Manager(s). Once an application is registered, notification events are sent when the Tlink
status changes for example linkUp/linkDown for the switches for which it has registered.
DMCC call recording solutions - IP Migration Readiness and Optimization analysis
For DMCC call recording solutions, Avaya recommends that you use the Avaya IP Migration
Readiness and Optimization services to help you safely implement IP-based solutions in a stable,
optimized infrastructure.
These services include a two-phased, detailed analysis of the entire network to help assess
whether you can deploy a converged IP solution such as AE Services without adversely affecting
your existing network applications and services.
The first phase of this analysis is the Customer Infrastructure Readiness Survey (CIRS). Certified
Avaya engineers conduct a high-level evaluation of the local and wide area network infrastructure
to identify any significant network issues that must be resolved prior to deploying the proposed IP
solution.
The second phase of this analysis — Network Analysis/Network Optimization (NANO), is required
when the CIRS indicates that the network cannot support the proposed IP solution at the desired
performance levels. Starting with the information and data gathered for the CIRS, Avaya
engineers perform problem diagnosis to get at the root causes of network issues. They also
provide functional requirements and recommendations for a network design that optimizes all of
the resources needed to support the IP solution.
TSAPI service
Telephony Services API (TSAPI) is a C/C++ based API that provides a full complement of third-
party call control capabilities such as controlling specific calls or stations, completing routing of
incoming calls, receiving notifications of events, invoking Communication Manager features and
querying Communication Manager for information. Java Telephony API (JTAPI) is a client-side
interface to the TSAPI service, and, as such, it provides third party call control. For more
information about the TSAPI SDK and the JTAPI SDK, see SDKs on page 43.
Web services
Web services provide a higher-level abstraction than the finer grained APIs. Web services provide
convenient access to commonly used functionality through a published Web Services Definition
Language (WSDL) and Simple Object Access Protocol (SOAP) connectivity.
For more information about the Web services SDKs, see SDKs on page 43.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 15
Comments on this document? infodev@avaya.com
AE Services Product Summary
CVLAN service
The CallVisor LAN (CVLAN) service is a C/C++ based API that enables applications to exchange
Adjunct/Switch Application Interface (ASAI) messages with the AE ServicesServer. CVLAN
provides a full complement of third-party call control capabilities such as controlling specific calls
or stations, completing routing of incoming calls, receiving notifications of events, invoking
Communication Manager features and querying Communication Manager for information. CVLAN
is an Avaya specific protocol and is not intended for new application development.
DLG service
The DEFINITY LAN Gateway (DLG) service tunnels messages over TCP/IP. That is, the DLG
service supports a set of TCP/IP connections for the communications channel between
Communication Manager and AE Services. The DLG service is also used for transporting ASAI/Q.
931 messages. DLG is an Avaya specific protocol and is not intended for new application
development.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 16
Comments on this document? infodev@avaya.com
AE Services configuration at a glance
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 17
Comments on this document? infodev@avaya.com
Chapter 5: Network Security and Reliability
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 18
Comments on this document? infodev@avaya.com
Secure application links
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 19
Comments on this document? infodev@avaya.com
Network Security and Reliability
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 20
Comments on this document? infodev@avaya.com
Support for an Enterprise Survivable Server configuration
the ability for media gateways, endpoints, application servers like AE Services and its applications
to continue their operations without major interruption.
AE Services recommends that all applications in an ESS configuration connect to a local AE
Services server which, in turn, is connected to either the media server at the main site or a media
gateway with an ESS or LSP at the remote site. In this configuration, the applications and
associated AE Services server at the remote sites are always active and are supplying
functionality for the local resources at the remote site. This type of configuration ensures the most
seamless survivability in an ESS configuration.
For more information, see White paper on Avaya Application Enablement Services High
Availability (HA) Configurations, located on the Avaya Support Web site http://www.avaya.com/
support.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 21
Comments on this document? infodev@avaya.com
Chapter 6: Guidelines for configuring AES
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 22
Comments on this document? infodev@avaya.com
AE Services deployment on Appliance Virtualization Platform on Dell™ PowerEdge™ R620
runtime state is preserved for these services, the application should also reestablish any
monitors/associations.
• The AE Services server can support a mixed environment that includes TSAPI, DMCC, Web
Services, CVLAN, and DLG based applications.
• The AE Services 7.0.x and later WebLM license will be preserved during a VMware offer type
upgrade when Solution Deployment Manager 7.1 and later is used to perform the AE
Services OVA upgrade.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 23
Comments on this document? infodev@avaya.com
Guidelines for configuring AES
• You cannot deploy AE Services Profile 2 or Profile 3 on Appliance Virtualization Platform with
CM duplex or NIC bonding on Dell R620 (4 NIC card) Server as Profile 2 or Profile 3 requires
dedicated NIC.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 24
Comments on this document? infodev@avaya.com
Chapter 7: AE Services Architecture
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 25
Comments on this document? infodev@avaya.com
AE Services Architecture
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 26
Comments on this document? infodev@avaya.com
AE Services architecture at a glance
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 27
Comments on this document? infodev@avaya.com
Chapter 8: Session Initiation Protocol (SIP)
SIP support
The Session Initiation Protocol (SIP) is a control (signaling) protocol for creating, modifying, and
terminating sessions with one or more participants. These sessions include Internet telephone
calls, multimedia distribution, and multimedia conferences. In more familiar terms, SIP means real-
time communication, presence, and collaboration in a variety of forms including voice, video, or
instant text messaging.
Specific Avaya SIP endpoints can be controlled with AE Services 4.1 or later and Communication
Manager 5.0 or later. AE Services 5.2 or later supports SIP enabled endpoints Avaya 96XX
(including 9620, 9630, 9630G, 9640 and 9640 G), and 9601 (SIP Only) with firmware version 2 or
greater and Avaya 16CC with all firmware versions.
AE Services 8.0.1 and later support J169 and J179 series phones with SIP 2.0 firmware. The
station type should be set to 96x1SIP or 96x1SIPCC in case of 1PCC operation for
Communication Manager 8.0. From Communication Manager Release 8.0.1, you can use J169 or
J179 template.
The requirements for SIP support are as follows:
• Communication Manager 5.0 or later
• Session Manager
AE Services 4.1 with Communication Manager 5.0 and Session Manager introduced the ability to
control Avaya SIP endpoints via TSAPI/JTAPI. This capability is not available through DLG.
The following table lists the SIP endpoints that have been tested to date.
In general, all AE Services third-party call control functions are supported for these SIP endpoints,
except for the limitations outlined in the next section.
Endpoint Administere Endpoint AE Services Communication Manager/Session
d as Firmware Release Manager Pair
Communication Session Manager
Manager- ES Release
Release
9620 9620SIP 2.6 SP12 8.1.1 8.1.1 8.1.1
9640 9640SIP 2.6 SP12 8.1.1 8.1.1 8.1.1
9640G 9640SIP 2.6 SP12 8.1.1 8.1.1 8.1.1
Table continues…
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 28
Comments on this document? infodev@avaya.com
SIP limitations
SIP limitations
The following topics list the SIP limitations for AE Services. For more information about SIP
limitations, see the Application Enablement Services Release Notes.
DMCC
All third-party call control capabilities are supported for the endpoints listed in SIP support on
page 28. The following scenarios are not supported for SIP endpoints:
• The media forking implementation approach to call recording introduced in AE Services 4.2 is
not supported. That is, an application registering a DMCC softphone in dependent mode with
the same extension as the user's SIP phone or softphone is not supported. If the DMCC
endpoint is registered as dependent to the SIP extension, it will not receive media.
• With respect to device control, DMCC cannot register an application controlled softphone in
dependent mode with the same extension as the user's SIP phone or softphone for purposes
such as pressing buttons, monitoring LEDs, and monitoring display.
TSAPI/JTAPI
All third-party call control capabilities are supported for the endpoints listed in SIP support on
page 28, except the following capabilities:
• Third-Party Selective Listening Hold
• Third-Party Selective Listening Retrieve
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 29
Comments on this document? infodev@avaya.com
Session Initiation Protocol (SIP)
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 30
Comments on this document? infodev@avaya.com
Chapter 9: AE Services Licensing
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 31
Comments on this document? infodev@avaya.com
AE Services Licensing
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 32
Comments on this document? infodev@avaya.com
Application Enablement Protocol connections licensing
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 33
Comments on this document? infodev@avaya.com
AE Services Licensing
You can use WebLM to determine the number of licensed AEP connections. You can check for the
number of AEP connections on the AE Services License page.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 34
Comments on this document? infodev@avaya.com
Device, Media, and Call Control (DMCC) licensing
Note:
Regardless of whether DMCC registrations are licensed on Communication Manager or on AE
Services, the addition of a DMCC station on Communication Manager also consumes an
IP_STA license and an STA license.
DMCC Call Information Service
Licenses are not required to use the DMCC Call Information Service.
DMCC Call Control Service
To use the DMCC Call Control Service, you must license and enable Computer Telephony Adjunct
Links on Communication Manager. Because the DMCC Call Control Service uses third-party call
control, the AE Services TSAPI Basic Users license is also required.
DMCC/CMAPI Double Licensing Reconciliation Process
When Application Enablement Services (AES) was deployed on Communication Manager (CM)
releases prior to 6.x, DMCC Basic (formerly known as CMAPI Basic) licenses were also included
in the CM license file as IP_API_A licenses as well as in the AE Services license file for
compatibility reasons. This meant Avaya literally doubled the quantity of DMCC Basic licenses
with every order which still continues today (for example AE Services 6.3.3 deployed on a CM
5.2.x). This is creating a discrepancy between the customer’s quantities purchased and the actual
licenses in place and should be reconciled when the customer’s CM release is upgraded to 6.x or
newer, and or an AE Services upgrade or SA/UA recast (with existing CM 6+) or a license move is
requested in a CM 6.x (or later) environment.
Account teams are responsible to initiate reconciliations and should perform an analysis of current
license quantities. Once this analysis has been completed, Avaya Product Operations should be
engaged to make the actual corrections within Avaya’s licensing tools. The following tasks should
be performed by the account team with the customer:
• Verify the license quantities in AES, CM, and PLDS.
• Verify the license quantities purchased.
• If the customer has licenses that were not purchased, determine the total license quantities
along with the quantities that are in use.
- Determine the quantities to be purchased and/or removed.
- If licenses will be removed, determine what platform (CM, AES, PLDS) they will be
removed from and the associated quantities.
The following additional information will assist in determining an accurate inventory count of the
DMCC / CMAPI Basic licenses:
Note:
Some CM releases included a licensing quantity of 4-IP_API_As so the total license count
may need to reflect this quantity.
Note:
Avaya Self-Service Offers add some additional complexity to determining the total license
count because they use the IP_API_A with Voice Portal and Experience Portal H.323
connections and our Self-Service Offers support CM 6.x and 7.x (along with pre-PLDS CMs:
CM 5.2.x with RFA). This needs to be taken into account in any reconciliation.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 35
Comments on this document? infodev@avaya.com
AE Services Licensing
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 36
Comments on this document? infodev@avaya.com
TSAPI service (including JTAPI) licensing
Once a TSAPI basic user license has been allocated on behalf of a station, that license will remain
in use as long as one of the following conditions exists:
• The station is being monitored.
• There are any calls present at the station.
Once a TSAPI basic user license has been allocated on behalf of an ACD split, that license will
remain in use as long as the ACD split is being monitored.
Note:
The TSAPI basic user licenses may be reserved or pre-allocated through OAM. The reserved
TSAPI basic user licenses are acquired when the TSAPI Service is started and remain in use
until the TSAPI Service is stopped.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 37
Comments on this document? infodev@avaya.com
AE Services Licensing
The TSAPI Advanced License requires that you license and enable the Communication Manager
feature for Computer Telephony Adjunct Links.
If you have a routing application that requires additional capacity, you have the option of licensing
the Increased Adjunct Route Capacity feature on Communication Manager.
Once a TSAPI advanced license is acquired on behalf of a Communication Manager server, that
license remains in use till the TSAPI Service is stopped or restarted.
CVLAN licensing
The CVLAN Service provides third-party call control. The CVLAN Service is integrated with Avaya
applications, and it is used by customer applications.
• When the CVLAN Service is used for customer applications, it requires a Communication
Manager license for ASAI Core. CVLAN bundles ASAI Core and ASAI Plus for a single
Communication Manager. Optionally, you can license the following features on
Communication Manager: ASAI Plus, CTI Stations, Phantom Calls, Adjunct Route, and
Increased Adjunct Route Capacity. Customer applications must use an ASAI-IP link type on
Communication Manager. This link type requires ASAI Core and ASAI Plus.
• Avaya Interaction Center (IC) requires an ADJ-IP link type.
Note:
Avaya IC is the only CVLAN application that can use an ADJ-IP link on Communication
Manager.
DLG licensing
The DLG Service requires a Communication Manager license for ASAI Core. DLG bundles ASAI
Core and ASAI Plus for a single Communication Manager. Optionally, you can license the
following features on Communication Manager: ASAI Plus, CTI Stations, Phantom Calls, Adjunct
Route, and Increased Adjunct Route Capacity. Customer applications must use an ASAI-IP link
type on Communication Manager. This link type requires ASAI Core and ASAI Plus.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 38
Comments on this document? infodev@avaya.com
Enterprise-wide licensing
Enterprise-wide licensing
AE Services supports enterprise-wide licensing. With enterprise-wide licensing, AE Services
customers are able to purchase any number of licenses and then allocate those licenses to
various AE Servers at their own discretion. This means that AE Services customers are able to
pool or share all AE Services server features, and Rights To Use (RTU) among AE Servers. This
applies only to AE Services features licensed in the AE Services license file and not those
licensed in the Communication Manager license file.
• To compare standard licensing with enterprise-wide licensing, see Comparison of standard
licensing and enterprise-wide licensing on page 39.
• For examples of licensing configurations, see Licensing configuration examples on page 40.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 39
Comments on this document? infodev@avaya.com
AE Services Licensing
Standard licensing
In a standard licensing configuration for Software-only offer, the standard license file (SLF) is
installed on the AE Services server and is controlled by the WebLM server running on the AE
Services server.
The following figure illustrates the standard licensing configuration.
Note:
If you use the standalone configuration, use the default settings on the WebLM Server
Address page in the AE Services Management Console.
Standalone configuration (without enterprise-wide licensing)
Note:
The default IP address, 127.0.0.1, shown in the illustration above is for both, the AE Services
Software-only offer and VMware offer.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 40
Comments on this document? infodev@avaya.com
Licensing configuration examples
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 41
Comments on this document? infodev@avaya.com
AE Services Licensing
Note:
Beginning with AE Services 7.0, System Platform is not supported.
Note:
Beginning with AE Services 7.0, System Platform is not supported.
Caution:
Using the ELF-only configuration is not recommended because network latency and outages
can affect the ability of the AE Services server to acquire licenses, and it creates a single point
of failure for licensing.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 42
Comments on this document? infodev@avaya.com
Chapter 10: Application Enablement
Services Client and SDKs
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 43
Comments on this document? infodev@avaya.com
Chapter 11: Communication Manager
features not supported with AE
Services
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 44
Comments on this document? infodev@avaya.com
Communication Manager features not supported
• CVLAN: Because the CVLAN service is implemented using ASAI, CVLAN support for this
feature is also incomplete.
• TSAPI: Because the TSAPI service is implemented using ASAI, TSAPI support for this
feature is also incomplete.
• JTAPI: Because JTAPI is an interface to TSAPI, JTAPI support for this feature is also
incomplete.
Call Park
• ASAI: A call may be parked manually at a station by using the call park button (with or
without the conference and transfer buttons), or by using the feature access code and the
conference or transfer buttons. When a call is parked using the call park button (without
either the conference or the transfer buttons) no event reports are generated. When the call
is unparked, a Connected Event Report is generated with the calling and called numbers
indicating the station on which the call had been parked, and the connected number is that of
the station unparking the call. If the call remains active at the parking station (via conference),
no changes occur to the listening disconnected paths as a result of parking. If the call drops
from the parking station (via transfer), its paths are disconnected from everyone on the call. A
single-step conference request will be denied if the call is parked.
• CVLAN: Because the CVLAN service is implemented using ASAI, CVLAN support for this
feature is also incomplete.
• TSAPI: Because the TSAPI service is implemented using ASAI, TSAPI support for this
feature is also incomplete.
• JTAPI: Because JTAPI is an interface to TSAPI, JTAPI support for this feature is also
incomplete.
Meet-me Conference feature
The Meet-me Conference feature is not supported in AE Services.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 45
Comments on this document? infodev@avaya.com
Chapter 12: Capacities for AE Services
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 46
Comments on this document? infodev@avaya.com
Capacities for AE Services on Appliance Virtualization Platform
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 47
Comments on this document? infodev@avaya.com
Capacities for AE Services
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 48
Comments on this document? infodev@avaya.com
Capacities for calls in DMCC applications
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 49
Comments on this document? infodev@avaya.com
Capacities for AE Services
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 50
Comments on this document? infodev@avaya.com
Capacities for calls in DMCC applications
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 51
Comments on this document? infodev@avaya.com
Capacities for AE Services
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 52
Comments on this document? infodev@avaya.com
Capacities for calls in DMCC applications
Note:
Traffic rate for applications is a gap of 10 seconds between each set of 100 registrations.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 53
Comments on this document? infodev@avaya.com
Capacities for AE Services
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 54
Comments on this document? infodev@avaya.com
System capacities – Communication Manager
FIPS Communication Manager are used, you can calculate the number of registrations
DMCC can support by considering that a H323TLS signaling channel consumes double
the resources as that of a non-H323TLS DMCC registration.
• Supported Communication Manager versions for FIPS and the H323TLS Security Profile.
- The H323TLS Security Profile when used with Processor Ethernet is supported with the
Communication Manager FIPS template for Communication Manager 6.3.6 and later.
- The H323TLS Security Profile when used with CLAN is supported with the Communication
Manager FIPS template for Communication Manager 6.3.7 and later.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 55
Comments on this document? infodev@avaya.com
Capacities for AE Services
Note:
The overall system limit is not restricted by the type of underlying transport that is used. For
example, either a single Processor Ethernet connection or 10 CLANs plus 1 redundant CLAN
will be able to reach 2000 msgs/sec.
ASAI associations
The number of supported generic associations on the AE Services server is 128,000.
ASAI capacities
If you are using ASAI, you can administer up to 16 bridged appearances and other
Communication Manager group features, such as Answer Coverage Group, in total.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 56
Comments on this document? infodev@avaya.com
TSAPI service capacities
Note:
A client connection refers to a unique AE
Services session established by a TSAPI
application. A single client connection may be
used to monitor and control multiple stations or
agents.
Links 16 (each to a different Communication Manager)
Note:
For any AE Server, there may be only one TSAPI link to any given Communication Manager.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 57
Comments on this document? infodev@avaya.com
Chapter 13: AE Services Documentation
Planners
If you are involved with planning an Application Enablement Services server installation use this
document, the Avaya Aura® Application Enablement Services Overview and Specification,
02-300360. Depending on the scope of your planning, you might want to consult additional
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 58
Comments on this document? infodev@avaya.com
Guidelines for selecting documents based on your role within an organization
documents for more information. The following sections provide information about using additional
documents for implementing Application Enablement Services.
AE Services integration with Microsoft Office Communications Server and
Microsoft Lync Server 2010 and 2013
If you plan to integrate AE Services with Microsoft Office Live Communications Server 2005,
Microsoft Office Communications Server 2007, or Microsoft Lync Server 2010 or 2013, see the
following documents.
• Deploying Avaya Aura® Application Enablement Services for Microsoft® Lync Server
Products, 02–601893
• Deploying Avaya Aura® Application Enablement Services in Software-Only Environment, 02–
300355. If your integration uses the AE Services Software-Only server, consult this document
for information about installing AE Services.
• Administering Avaya Aura® Application Enablement Services. Use this document for
information about administering Avaya Communication Manager and the AE Services server.
• Avaya Aura® Application Enablement Services Management Console online help. Use this
online help for information about administering the AE Services server.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 59
Comments on this document? infodev@avaya.com
AE Services Documentation
Note:
AE Services does not assume that you will install a browser on the AE Server. To access
WebLM (Avaya Web-based license management software) and to administer AE Services,
you need a computer running a browser with network access to the AE Server.
If you are installing TSAPI and CVLAN clients and SDKs, see Avaya Aura® Application
Enablement Services TSAPI and CVLAN Client and SDK Installation Guide, 02–300543.
Application developers
Application Enablement Services provides Software Development Kits (SDKs) and programming
documents for developing applications. For a list of the Application Enablement Services SDKs,
see SDKs on page 43.
Avaya DevConnect Program
Application developers who want to take advantage of the AE Services APIs or protocols are
encouraged to participate in the Avaya DevConnect Program. The Avaya DevConnect Program
gives you access to a comprehensive set of support and marketing programs that help you create
the new generation of intelligent communications solutions. For more information, go to the Avaya
DevConnect Web site www.avaya.com/devconnect.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 60
Comments on this document? infodev@avaya.com
Guidelines for selecting documents based on your role within an organization
For more information about Web services, see the Avaya Aura® Application Enablement Services
Web Services Programmer's Guide, 02–300362.
TSAPI programmers
If you program to TSAPI, use the following documents to develop or maintain your applications.
• Avaya Aura® Application Enablement Services TSAPI for Avaya Communication Manager
Programmer’s Reference, 02-300544. 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 Aura® Application
Enablement Services TSAPI and CVLAN Client and SDK Installation Guide, 02-300543.
• Application Enablement Services TSAPI Programmer’s Reference, 02-300545. This
document describes the Telephony Services API, which is based on ECMA CSTA Standards
179 and 180. This document is required only if you need to learn the fundamental principles
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 61
Comments on this document? infodev@avaya.com
AE Services Documentation
of TSAPI. If you are developing or maintaining TSAPI applications, and you are familiar with
TSAPI, use the Application Enablement Services TSAPI for Avaya Communication Manager
Programmer’s Reference, 02-300544, as your primary reference.
JTAPI programmers
If you program to JTAPI, use the following documents to develop or maintain your applications.
• Avaya Aura® Application Enablement Services JTAPI Programmers Guide, 02-603488. This
document describes how to use the AE Services JTAPI implementation to develop, debug,
and deploy telephony applications.
• Avaya Aura® Application Enablement Services JTAPI Programmer’s Reference (an HTML
document available on the Web only at the Avaya Support Site and the Avaya DevConnect
Site). This document provides you with a reference to API calls in the Avaya implementation
of the Java Telephony API. This document describes 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.
CVLAN programmers
If you program to the CVLAN API (which is an implementation of the ASAI protocol), use the
following documents.
Note:
AE Services does not support newly-developed CVLAN applications.
• Avaya Aura® Application Enablement Services CVLAN Programmer’s Reference, 02-300546.
Use this document as your primary reference for CVLAN applications. It documents all call
control services provided by Avaya Communication Manager.
• For information about installing the CVLAN clients and SDKs, see the Avaya Aura®
Application Enablement Services TSAPI and CVLAN Client and SDK Installation Guide,
02-300543.
• Application Enablement Services ASAI Technical Reference, 03–300549. The CVLAN call
control capabilities are based on the capabilities described in this document. Consult this
document when a high level of detail is required.
• Application Enablement Services ASAI Protocol Reference, 03–300550. CVLAN uses the
ASAI protocol. Consult this document when a high level of detail regarding information
elements and the layout of ASAI messages is required.
ASAI programmers
If you program directly to the Adjunct Switch Application Interface (ASAI) protocol, use the
following documents as your primary reference.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 62
Comments on this document? infodev@avaya.com
Guidelines for selecting documents based on your role within an organization
Note:
AE Services does not support newly-developed ASAI applications.
• Application Enablement Services ASAI Technical Reference, 03–300549. This document
provides technical descriptions of ASAI third-party call control capabilities.
• Application Enablement Services ASAI Protocol Reference, 03–300550. This document
provides byte-level descriptions of ASAI messages.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 63
Comments on this document? infodev@avaya.com
Chapter 14: Resources
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 64
Comments on this document? infodev@avaya.com
Application Enablement Services documentation
Related links
Finding documents on the Avaya Support website on page 65
Accessing the port matrix document on page 66
Avaya Documentation Portal navigation on page 66
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 65
Comments on this document? infodev@avaya.com
Resources
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 66
Comments on this document? infodev@avaya.com
Training
Navigate to the My Content > My Docs menu, and do any of the following:
- Create, rename, and delete a collection.
- Add content from various documents to a collection.
- Save a PDF of selected content in a collection and download it to your computer.
- Share content in a collection with others through email.
- Receive content that others have shared with you.
• Add yourself as a watcher by using the Watch icon ( ).
Navigate to the My Content > Watch list menu, and do the following:
- Set how frequently you want to be notified, starting from every day to every 60 days.
- Unwatch selected content, all content in a document, or all content on the Watch list page.
As a watcher, you are notified when content is updated or deleted from a document, or the
document is removed from the portal.
• Share a section on social media platforms, such as Facebook, LinkedIn, and Twitter.
• Send feedback on a section and rate the content.
Note:
Some functionality is only available when you log in to the portal. The available functionality
depends on the role with which you are logged in.
Related links
Application Enablement Services documentation on page 64
Training
The following courses are available on the Avaya Learning website at http://www.avaya-
learning.com. After logging in to the website, enter the course code or the course title in the
Search field and click Go to search for the course.
Course code Course title
20980W What's New with Avaya Aura® Release 8.1
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 67
Comments on this document? infodev@avaya.com
Resources
Support
Go to the Avaya Support website at https://support.avaya.com for the most up-to-date
documentation, product notices, and knowledge articles. You can also search for release notes,
downloads, and resolutions to issues. Use the online service request system to create a service
request. Chat with live agents to get answers to questions, or request an agent to connect you to a
support team if an issue requires additional expertise.
Related links
Using the Avaya InSite Knowledge Base on page 68
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 68
Comments on this document? infodev@avaya.com
Support
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 69
Comments on this document? infodev@avaya.com
Appendix A: AE Services compatibility
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 70
Comments on this document? infodev@avaya.com
Product compatibility
Product compatibility
For the latest and most accurate compatibility information, go to http://support.avaya.com/
CompatibilityMatrix/Index.aspx.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 71
Comments on this document? infodev@avaya.com
AE Services compatibility
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 72
Comments on this document? infodev@avaya.com
Glossary
Application Refers to the secure TCP connection between the AE Server and
Enablement Protocol Communication Manager. It tunnels ASAI messages and Call Information
(AEP) connection Services messages between AE Services and Communication Manager.
Authentication The process of validating the identity of a user by means of user profile
attributes.
Authorization The process of granting a user the ability to carry out certain activities
based on permissions.
Call Information The Call Information Service allows applications to get detailed call
Service information and to determine the status of the call information link.
CLAN Control LAN. CLAN refers to the Avaya TN799 Control LAN circuit pack,
which resides on Communication Manager. AE Services relies on the
CLAN for communicating with Communication Manager.
CTI Link The term CTI link refers to a generic link type that is used in the context of
Communication Manager administration. As a generic link type, it can
refer to any of the following AE Services links: CVLAN links, DLG links,
and TSAPI links (JTAPI and the Telephony Web Service use TSAPI links).
When an OAM Web page, such as TSAPI Service Summary, displays a
column heading for a CTI link type, it is referring to TSAPI link as it is
administered on Communication Manager. Up to 64 links can be
administered on Communication Manager.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 73
Comments on this document? infodev@avaya.com
Glossary
DMCC Service Device, Media, and Call Control. The DMCC Service encompasses
Device Control, Media Control, and Call Control capabilities. Device
Control enables applications to monitor and control station lamps and
displays. Media Control allows applications to direct media connections,
play sounds, and interpret voice/tones on a media stream. Call Control
allows applications to monitor and control calls.
First-Party Call First-party call control refers to the application acting as the user would
Control operate their telephone. The application invokes operations, such as, Go
off-hook, Press button, and so forth, until the switch collects enough digits
to initiate the call.
PLDS Product Licensing and Delivery System. AE Services uses the PLDS for
license management and software distribution.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 74
Comments on this document? infodev@avaya.com
Registration, Administration, and Status
Switch Connection Switch Connection Name is a term that refers to either of the following:
Name (1) A collection of Host Names or IP addresses associated with one (and
only one) switch. This definition applies to the TSAPI Service, the Web
Telephony Service, the CVLAN Service, and the DLG Service. (2) A
collection of H.323 Gatekeepers that are associated with one (and only
one) switch. AE Services supports up to 16 switch connections to
Communication Manager. Switch Connection names, also referred to as
switch connections can consist of multiple CLAN connections (up to 16).
Telephony Web An interface that enables high level call control functionality over standard
Service web services interfaces (SOAP/XML).The service hides the complicated
concepts associated with traditional CSTA based call control such as
connections, call identifiers and call states.
Third-Party Call Third-party call control means that, rather than acting as the user, the
Control application is making requests on the behalf of the user. A third-party
make call says “Make a call from extension X to extension Y”.
Tlink A Tlink is a service identifier that is created when the administrator adds a
TSAPI Link in AE Services OAM. A Tlink refers to a switch connection
between a specific switch and a specific AE Server.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 75
Comments on this document? infodev@avaya.com
Glossary
Transport link A transport link is a secure TCP/IP connection between the AE Services
server and a CLAN on Communication Manager. When the AE Services
Transport Service starts up, it establishes the transport link between the
AE Services server and the Communication Manager server, based on
administering a switch connection in AE Services Management Console.
The CLAN IP addresses that you administer from the Edit CLAN IPs page
in AE Services Management Console are used to set up TLS connections
between AE Services and Communication Manager. These TLS
connections are called transport links.
Web Services A set of standards that allow a service to be described and consumed in a
platform-neutral way.
November 2019 Avaya Aura® Application Enablement Services Overview and Specification 76
Comments on this document? infodev@avaya.com