+ All Categories
Home > Documents > Ce Overview and Specification 3 0 i1

Ce Overview and Specification 3 0 i1

Date post: 02-Oct-2015
Category:
Upload: jose-meneses-jr
View: 4 times
Download: 0 times
Share this document with a friend
Description:
Ce Overview and Specification 3 0 i1 e3trert
Popular Tags:
38
Avaya Aura ® Collaboration Environment Overview and Specification Release 3.0 August 2014
Transcript
  • Avaya Aura Collaboration EnvironmentOverview and Specification

    Release 3.0August 2014

  • 2014 Avaya Inc.

    All Rights Reserved.

    Notice

    While reasonable efforts have been made to ensure that theinformation in this document is complete and accurate at the time ofprinting, Avaya assumes no liability for any errors. Avaya reserves theright to make changes and corrections to the information in thisdocument without the obligation to notify any person or organization ofsuch changes.

    Documentation disclaimer

    Documentation means information published by Avaya in varyingmediums which may include product information, operating instructionsand performance specifications that Avaya may generally makeavailable to users of its products and Hosted Services. Documentationdoes not include marketing materials. Avaya shall not be responsiblefor any modifications, additions, or deletions to the original publishedversion of documentation unless such modifications, additions, ordeletions were performed by Avaya. End User agrees to indemnify andhold harmless Avaya, Avaya's agents, servants and employees againstall claims, lawsuits, demands and judgments arising out of, or inconnection with, subsequent modifications, additions or deletions tothis documentation, to the extent made by End User.

    Link disclaimer

    Avaya is not responsible for the contents or reliability of any linkedwebsites referenced within this site or documentation provided byAvaya. Avaya is not responsible for the accuracy of any information,statement or content provided on these sites and does not necessarilyendorse the products, services, or information described or offeredwithin them. Avaya does not guarantee that these links will work all thetime and has no control over the availability of the linked pages.

    Warranty

    Avaya provides a limited warranty on Avaya hardware and software.Refer to your sales agreement to establish the terms of the limitedwarranty. In addition, Avayas standard warranty language, as well asinformation regarding support for this product while under warranty isavailable to Avaya customers and other parties through the AvayaSupport website: http://support.avaya.com or such successor site asdesignated by Avaya. Please note that if you acquired the product(s)from an authorized Avaya Channel Partner outside of the United Statesand Canada, the warranty is provided to you by said Avaya ChannelPartner and not by Avaya.

    Licenses

    THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYAWEBSITE, HTTP://SUPPORT.AVAYA.COM/LICENSEINFO ORSUCH SUCCESSOR SITE AS DESIGNATED BY AVAYA, AREAPPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/ORINSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC.,ANY AVAYA AFFILIATE, OR AN AVAYA CHANNEL PARTNER (ASAPPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYAOR AN AVAYA CHANNEL PARTNER. UNLESS OTHERWISEAGREED TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTENDTHIS LICENSE IF THE SOFTWARE WAS OBTAINED FROMANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR ANAVAYA CHANNEL PARTNER; AVAYA RESERVES THE RIGHT TOTAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE USINGOR SELLING THE SOFTWARE WITHOUT A LICENSE. BYINSTALLING, DOWNLOADING OR USING THE SOFTWARE, ORAUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OFYOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING,DOWNLOADING OR USING THE SOFTWARE (HEREINAFTERREFERRED TO INTERCHANGEABLY AS YOU AND END USER),AGREE TO THESE TERMS AND CONDITIONS AND CREATE ABINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THEAPPLICABLE AVAYA AFFILIATE (AVAYA).

    Avaya grants you a license within the scope of the license typesdescribed below, with the exception of Heritage Nortel Software, forwhich the scope of the license is detailed below. Where the orderdocumentation does not expressly identify a license type, theapplicable license will be a Designated System License. The applicablenumber of licenses and units of capacity for which the license is grantedwill be one (1), unless a different number of licenses or units of capacityis specified in the documentation or other materials available to you.Software means Avayas computer programs in object code, providedby Avaya or an Avaya Channel Partner, whether as stand-aloneproducts, pre-installed , or remotely accessed on hardware products,and any upgrades, updates, bug fixes, or modified versions thereto.Designated Processor means a single stand-alone computing device.Server means a Designated Processor that hosts a softwareapplication to be accessed by multiple users. Instance means a singlecopy of the Software executing at a particular time: (i) on one physicalmachine; or (ii) on one deployed software virtual machine (VM) orsimilar deployment.

    License types

    CPU License (CP). End User may install and use each copy or Instanceof the Software on a number of Servers up to the number indicated inthe order provided that the performance capacity of the Server(s) doesnot exceed the performance capacity specified for the Software. EndUser may not re-install or operate the Software on Server(s) with alarger performance capacity without Avayas prior consent andpayment of an upgrade fee.

    Named User License (NU). You may: (i) install and use the Softwareon a single Designated Processor or Server per authorized NamedUser (defined below); or (ii) install and use the Software on a Server solong as only authorized Named Users access and use the Software.Named User, means a user or device that has been expresslyauthorized by Avaya to access and use the Software. At Avayas solediscretion, a Named User may be, without limitation, designated byname, corporate function (e.g., webmaster or helpdesk), an e-mail orvoice mail account in the name of a person or corporate function, or adirectory entry in the administrative database utilized by the Softwarethat permits one user to interface with the Software.

    Copyright

    Except where expressly stated otherwise, no use should be made ofmaterials on this site, the Documentation, Software, Hosted Service,or hardware provided by Avaya. All content on this site, thedocumentation, Hosted Service, and the Product provided by Avayaincluding the selection, arrangement and design of the content isowned either by Avaya or its licensors and is protected by copyrightand other intellectual property laws including the sui generis rightsrelating to the protection of databases. You may not modify, copy,reproduce, republish, upload, post, transmit or distribute in any way anycontent, in whole or in part, including any code and software unlessexpressly authorized by Avaya. Unauthorized reproduction,transmission, dissemination, storage, and or use without the expresswritten consent of Avaya can be a criminal, as well as a civil offenseunder the applicable law.

    Virtualization

    Each product has its own ordering code and license types. Note thateach Instance of a product must be separately licensed and ordered.For example, if the end user customer or Avaya Channel Partner wouldlike to install two Instances of the same type of products, then twoproducts of that type must be ordered.

    Third Party Components

    Third Party Components mean certain software programs or portionsthereof included in the Software or Hosted Service may containsoftware (including open source software) distributed under third partyagreements (Third Party Components), which contain termsregarding the rights to use certain portions of the Software (Third PartyTerms). As required, information regarding distributed Linux OSsource code (for those Products that have distributed Linux OS sourcecode) and identifying the copyright holders of the Third Party

    2 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    http://support.avaya.com/http://support.avaya.com/LicenseInfomailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Components and the Third Party Terms that apply is available in theDocumentation or on Avayas website at: http://support.avaya.com/Copyright or such successor site as designated by Avaya. You agreeto the Third Party Terms for any such Third Party Components.

    Note to Service Provider

    The Product or Hosted Service may use Third Party Componentssubject to Third Party Terms that do not allow hosting and require aService Provider to be independently licensed for such purpose. It isyour responsibility to obtain such licensing.

    Preventing Toll Fraud

    Toll Fraud is the unauthorized use of your telecommunicationssystem by an unauthorized party (for example, a person who is not acorporate employee, agent, subcontractor, or is not working on yourcompany's behalf). Be aware that there can be a risk of Toll Fraudassociated with your system and that, if Toll Fraud occurs, it can resultin substantial additional charges for your telecommunications services.

    Avaya Toll Fraud intervention

    If you suspect that you are being victimized by Toll Fraud and you needtechnical assistance or support, call Technical Service Center TollFraud Intervention Hotline at +1-800-643-2353 for the United Statesand Canada. For additional support telephone numbers, see the AvayaSupport website: http://support.avaya.com or such successor site asdesignated by Avaya. Suspected security vulnerabilities with Avayaproducts should be reported to Avaya by sending mail to:[email protected].

    Trademarks

    The trademarks, logos and service marks (Marks) displayed in thissite, the Documentation, Hosted Service(s), and Product(s) providedby Avaya are the registered or unregistered Marks of Avaya, itsaffiliates, or other third parties. Users are not permitted to use suchMarks without prior written consent from Avaya or such third partywhich may own the Mark. Nothing contained in this site, theDocumentation, Hosted Service(s) and Product(s) should be construedas granting, by implication, estoppel, or otherwise, any license or rightin and to the Marks without the express written permission of Avaya orthe 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. andother countries.

    Downloading Documentation

    For the most current versions of Documentation, see the AvayaSupport website: http://support.avaya.com, or such successor site asdesignated by Avaya.

    Contact Avaya Support

    See the Avaya Support website: http://support.avaya.com for Productor Hosted Service notices and articles, or to report a problem with yourAvaya Product or Hosted Service. For a list of support telephonenumbers and contact addresses, go to the Avaya Support website: http://support.avaya.com (or such successor site as designated byAvaya), scroll to the bottom of the page, and select Contact AvayaSupport.

    Avaya Aura Collaboration Environment Overview and Specification August 2014 3

    http://support.avaya.com/Copyrighthttp://support.avaya.com/Copyrighthttp://support.avaya.comhttp://support.avaya.comhttp://support.avaya.comhttp://support.avaya.com

  • 4 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Contents

    Chapter 1: Introduction...................................................................................................... 7Purpose..................................................................................................................................................... 7Intended audience.................................................................................................................................... 7Documentation.......................................................................................................................................... 7Training..................................................................................................................................................... 9Collaboration Environment videos............................................................................................................ 10Support...................................................................................................................................................... 10Warranty.................................................................................................................................................... 11

    Chapter 2: Overview........................................................................................................... 13Avaya Aura Collaboration Environment overview................................................................................... 13

    Whats new in the 3.0 release.......................................................................................................... 14VMware deployment......................................................................................................................... 15Service types.................................................................................................................................... 15System Interactions.......................................................................................................................... 16

    Topology................................................................................................................................................... 17Feature description................................................................................................................................... 18

    Software development kit................................................................................................................. 18Development environment and tools................................................................................................ 20Connector Services.......................................................................................................................... 20Clusters............................................................................................................................................ 22Service Profiles................................................................................................................................ 23Preferred version of a snap-in.......................................................................................................... 23Incoming and outgoing HTTP service invocation............................................................................. 23System Manager Geographic Redundancy support for Collaboration Environment........................ 24

    Chapter 3: Interoperability................................................................................................. 27Product compatibility................................................................................................................................. 27Collaboration Environment requirements.................................................................................................. 27Avaya Media Server requirements............................................................................................................ 28

    Chapter 4: Performance specifications............................................................................ 29Capacity and scalability specification........................................................................................................ 29High availability......................................................................................................................................... 30

    Chapter 5: Security............................................................................................................. 33Security specification................................................................................................................................ 33Port utilization............................................................................................................................................ 34

    Chapter 6: Licensing Requirements.................................................................................. 35Licensing requirements............................................................................................................................. 35Collaboration Environment platform licensing........................................................................................... 35

    Index..................................................................................................................................... 37

    Avaya Aura Collaboration Environment Overview and Specification August 2014 5

  • 6 Avaya Aura Collaboration Environment Overview and Specification August 2014

  • Chapter 1: Introduction

    PurposeThis document describes tested product characteristics and capabilities, including featuredescriptions, interoperability, performance specifications, security, and licensingrequirements.

    Intended audienceThis document is intended for people who want to gain a high-level understanding of theproduct features, functions, capacities, and limitations.

    DocumentationSee the following related documents at http://support.avaya.com.

    Title Description AudienceUnderstanding

    Avaya Aura CollaborationEnvironment Overview andSpecification

    Describes the CollaborationEnvironment platform from afunctional view. Includes a high-leveldescription of the platform as well astopology diagrams, customerrequirements, and designconsiderations.

    Sales engineersProgrammersSystemadministratorsServices andsupport personnel

    Avaya Aura System ManagerOverview and Specification

    Describes tested productcharacteristics and capabilities,including product overview andfeature descriptions, interoperability,performance specifications, security,and licensing requirements.

    Sales engineersProgrammersSystemadministratorsServices andsupport personnel

    Avaya Aura Collaboration Environment Overview and Specification August 2014 7

    http://support.avaya.com/

  • Title Description AudienceImplementing

    Deploying Avaya AuraCollaboration Environment

    Describes the procedures to deployand administer CollaborationEnvironment. Also contains theprocedures to deploy, administer, andlicense an Avaya Media Server foruse with Collaboration Environment.

    Services andsupport personnel

    Upgrading Avaya AuraCollaboration Environment

    Describes the procedures to upgradeCollaboration Environment fromrelease 2.0 to release 3.0.

    Services andsupport personnel

    Implementing andAdministering Avaya MediaServer 7.6

    Provides the procedures to install,configure, use, and troubleshootAvaya Media Server.

    SystemadministratorsServices andsupport personnel

    Implementing Avaya AuraSystem Manager

    Provides the procedures to install andconfigure Avaya Aura SystemManager.

    SystemadministratorsServices andsupport personnel

    Avaya Aura System Managerusing VMware in theVirtualized EnvironmentDeployment Guide

    Describes how to deploy Avaya AuraSystem Manager in a virtualizedenvironment using VMware.

    SystemadministratorsServices andsupport personnel

    Customizing

    Getting Started with the AvayaAura CollaborationEnvironment SDK

    Describes the procedures to installand configure the Eclipse IDE,Apache Maven, and the CollaborationEnvironment SDK.

    Programmers

    Avaya Aura CollaborationEnvironment Snap-inDevelopment Guide

    Describes the key concepts neededto develop the different types ofCollaboration Environment snap-ins.

    Programmers

    Avaya Aura CollaborationEnvironment FAQ andTroubleshooting for Snap-inDevelopers

    Provides snap-in troubleshootingprocedures. Answers questions suchas Why did my SDK installation fail?

    Programmers

    Avaya Aura CollaborationEnvironment API

    Overview and description of the APIclasses and uses.

    Programmers

    Supporting

    Maintaining andTroubleshooting Avaya AuraCollaboration Environment

    Contains the list of alarms and errorsrelated to Collaboration Environmentand the procedures to troubleshootand fix the problems.

    Services andsupport personnel

    Introduction

    8 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Title Description AudienceMaintaining andTroubleshooting Avaya AuraSession Manager

    Contains information fortroubleshooting Avaya Aura SessionManager, alarm code descriptions,and procedures for resolving alarms.

    Services andsupport personnel

    Troubleshooting Avaya AuraSystem Manager

    Provides procedures fortroubleshooting errors for SystemManager and the Avaya Auraapplications that System Managersupports.

    Services andsupport personnel

    Using

    Quick Start to Deploying AvayaAura CollaborationEnvironment Snap-ins

    Walks through the steps to install andadminister the different types of snap-ins.

    ProgrammersSystemadministrators

    Administering Avaya AuraCollaboration Environment

    Provides the procedures toadminister and configureCollaboration Environment and snap-ins.

    SystemAdministratorsServices andSupportpersonnel

    Administering Avaya AuraSession Manager

    Describes the routing administrationand management of Avaya AuraSession Manager instances.

    SystemAdministratorsServices andsupport personnel

    Administering Avaya AuraSystem Manager

    Describes the administration andmanagement of Avaya Aura SystemManager.

    SystemAdministratorsServices andsupport personnel

    TrainingThe 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 theSearch field and click Go to search for the course.

    Course code Course title8U00040E Knowledge Access: Avaya Aura Collaboration Environment

    Implementation and Support

    5105 Avaya Aura Collaboration Environment Implementation andMaintenance Test

    Training

    Avaya Aura Collaboration Environment Overview and Specification August 2014 9

    http://www.avaya-learning.com/http://www.avaya-learning.com/

  • Collaboration Environment videosCollaboration Environment provides the following videos to help in the development anddeployment of services. Access these videos at http://www.avaya.com/CEdeveloper

    Title Audience

    Getting Started with the CollaborationEnvironment SDK: Windows

    Programmers

    Getting Started with the CollaborationEnvironment SDK: Linux

    Programmers

    Creating Your First Service Part 1 Programmers

    Creating Your First Service Part 2 Programmers

    Server Installation and Configuration withvCenter

    System Administrators, Services andSupport personnel

    Server Installation and Configuration withoutvCenter

    System Administrators, Services andSupport personnel

    Service Installation, Configuration, and Test Programmers

    Understanding the Dynamic TeamFormation Sample Service

    Programmers

    Understanding the Hello Sample Service Programmers

    Understanding the MultiChannelBroadcast Sample Service

    Programmers

    Understanding the Whitelist Sample Service Programmers

    SupportPlatform supportGo to the Avaya Support website at www.avaya.com/Support for the most up-to-date productdocumentation, and product notices. Also search for release notes, service packs, andpatches. Use the online service request system to create a service request. Chat with liveagents to get answers to questions, or request an agent to connect you to a support team ifan issue requires additional expertise.

    Introduction

    10 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    http://www.avaya.com/CEdeveloperhttp://support.avaya.com/mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Developer supportGo to the Avaya DevConnect website at http://www.avaya.com/CEdeveloper to access theCollaboration Environment API, SDK, sample applications, developer-oriented technicaldocumentation, and training materials.

    WarrantyAvaya provides a 90-day limited warranty on Avaya Aura Collaboration Environment software.Refer to the sales agreement or other applicable documentation for detailed terms andconditions of the limited warranty. In addition, a description of Avayas standard warranty, anddetails for support under warranty, are available at the Avaya Support website http://avaya.com/Support or the Enterprise portal http://enterpriseportal.avaya.com/ptWeb/gs/services/SV0452/JobAidsTools.

    Warranty

    Avaya Aura Collaboration Environment Overview and Specification August 2014 11

    http://www.avaya.com/CEdeveloperhttp://support.avaya.com/http://support.avaya.com/http://enterpriseportal.avaya.com/ptWeb/gs/services/SV0452/JobAidsTools.http://enterpriseportal.avaya.com/ptWeb/gs/services/SV0452/JobAidsTools.

  • Introduction

    12 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Chapter 2: Overview

    Avaya Aura Collaboration Environment overviewThe Avaya Aura Collaboration Environment provides a virtualized and secure applicationplatform where Java programmers can develop and dynamically deploy advancedcollaboration capabilities that extend the power of Avaya Aura. A snap-in or a service is theterm used to describe this functionality. Customers, business partners, and Avaya developerscan use the platform as the deployment vehicle for their applications (services).

    Collaboration Environment acts as the platform for many Avaya products such as WebRTCSnap-in, Avaya Real-Time Speech Snap-in, Collaboration Designer, Context Store and WorkAssignment.

    The Collaboration Environment platform provides the following benefits:

    Rapid development by customers, partners, and Avaya organizations of services andapplications that snap-in to the Collaboration Environment platform.

    Developers can focus on building the collaboration services they need, without the needto develop a robust platform on which collaboration services are deployed and run.

    A robust Software Development Kit (SDK) with an easy-to-use API. Developers do notneed to understand the details of call processing to be able to develop exciting newcapabilities.

    The ability to perform operations such as:

    - Intercepting calls in to and out of the enterprise.

    - Redirecting calls to an alternate destination.

    - Blocking calls and optionally play an announcement to the caller.

    - Changing the presented caller ID of the calling or called party.

    The ability to place an outbound call for the purpose of playing announcements andcollecting digits.

    The ability to invoke web services for added functionality.

    The ability to expose web pages and web services for invocation by remote browsers andapplications.

    A Collaboration Bus that allows services to leverage each others capabilities via point-to-point and publish/subscribe messaging patterns.

    Avaya Aura Collaboration Environment Overview and Specification August 2014 13

  • A Common Data Manager framework that services use to access common informationstored on System Manager.

    Connector Services that provide access to email, Clicka Tell SMS (text messaging) andScopia (conferencing) host applications.

    The ability to add or replace Trust and Identity Certificates for increased security.

    Tools that log and monitor operations and provide troubleshooting support.

    High availability. For more information on high availability, see the High Availabilitysection.

    Collaboration Environment is a powerful snap-in delivery platform providing UnifiedCommunications and Contact Center customers and partners the ability to quickly delivercapabilities using the skill sets of todays enterprise and cloud application developers.

    Whats new in the 3.0 releaseThe following section specifies the new features and enhancements introduced in theCollaboration Environment Release 3.0:

    Clusters: You can create, view, edit, and delete Collaboration Environment clusters. Youcan also add Collaboration Environment servers to the cluster and assign specific snap-ins to the cluster. You can manage a server only after you add the server to a cluster.

    Load balancing: Collaboration Environment supports the load balancing feature todistribute HTTP and HTTPs requests across all the servers in a cluster.

    Data grid:Collaboration Environment supports data grid configuration on a cluster. Thedata grid is shared by all the servers in a cluster. For high availability, two servers aredesignated as LookUp Servers to run the LookUp services.

    You can now add trusted certificates at the cluster level.

    You can set the preferred version of a snap-in for clusters.

    Licensing tracking and enforcement has been introduced for the CollaborationEnvironment platform and for some of the snap-ins.

    Geographic redundancy: Collaboration Environment makes use of the System Managergeographic redundancy feature.

    Separate log files for each snap-in is available from this release. You can also modify thelogging level configuration for snap-ins.

    New maintenance tests for data grid and alarming.

    New Serviceability tools: the HTTP message trace tool, Collaboration Bus tracer andEvent Watcher tool. Enhanced capabilities have been introduced in the CollaborationEnvironment reporting tool.

    An eclipse plug in for the Software Development Kit has been introduced in thisrelease.

    Overview

    14 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Click to Call sample snap-in, Calling Policies sample snap-in and an enhanced whitelistsample snap-in have been introduced in this release.

    Snap-in alarming: The serviceability agent sends the snap-in alarms to System Manager.However, third party snap-ins do not reach Avaya.

    Eventing framework: Allows snap-ins to publish and subscribe for events, optionally usingfilters. Collaboration Environment produces call events over this framework. Non callintercept snap-ins also use this framework. A connector exists to enable remotepublishing of events through HTTP.

    New call and media API capabilitiesFrom this release you can:

    Use multiple invocations to fork to multiple numbers with the call forking functionality. Invoke media operations at any point during a call with no restrictions on the call control

    operations that are subsequently invoked. Play text-based announcements if both the nuance speech sever and the Real-time

    Speech snap-in are licensed and deployed. Invoke automatic speech recognition if both the nuance speech sever and the Real-time

    Speech snap-in are licensed and deployed. Perform this using voice XML.

    VMware deploymentCollaboration Environment is deployed into a VMware virtualized environment. It is deliveredas a VMware vAppliance in Open Virtual Appliance (OVA) format and runs on a customer-provided VMware instance (standard edition or better).

    Since Collaboration Environment is deployed in a virtualized VMware environment, all servicesare deployed into the virtualized environment with no additional work needed on the part ofthe service developer.

    Service typesServices that deploy on Collaboration Environment can be categorized as follows. A givenservice can fall into more than one category. The categories are not mutually exclusive.

    Call Intercept services Called Party and Calling Party servicesAll incoming and outgoing calls between the PSTN and the enterprise can take full advantageof Call Intercept services that run on Collaboration Environment. This is true regardless of thetype of endpoint (H.323 or SIP) and the type of trunk (ISDN or SIP). Station-to-station calls

    Avaya Aura Collaboration Environment overview

    Avaya Aura Collaboration Environment Overview and Specification August 2014 15

  • within the enterprise cannot invoke Call Intercept services even if the endpoints are SIPendpoints. There are two types of Call Intercept services:

    Based on who is being called, a Called Party service looks at the configuration data forthat called party to determine how to handle the call.

    Based on who is placing a call, a Calling Party service looks at the configuration data forthat calling party to determine how to handle the call.

    The Hello World service is an example of a Call Intercept service.

    Outbound Calling servicesOutbound Calling services can initiate calls to phone numbers for the purpose of playing pre-recorded announcements and optionally detecting button presses from the called phone. TheMulti-channel Broadcast service is an example of a one-party Outbound Calling service.

    Outbound Calling services can also initiate two-party calls to join two participants together ina call. The calling party is called first, and after answer a call is initiated to the called party.After the called party answers both the participants talk to each other. The Click to Callapplication is an example of a two-party Outbound Calling service.

    HTTP-invoked servicesHTTP-invoked services perform some action on receipt of an incoming HTTP request. Forexample, when it receives an incoming HTTP request, the Dynamic Team Formation servicecreates a Scopia video conference, then sends the conference URL to specified email and /or SMS recipients.

    The Multi-channel Broadcast service is another example of an HTTP-invoked service.

    Collaboration Bus-invoked servicesThe Collaboration Bus is a core module within Collaboration Environment that enables servicesto send messages to other services for the purpose of leveraging the functionality of the otherservices.

    Collaboration Bus-invoked services perform some action when they receive a message fromanother service on the Collaboration Bus.

    The email connector service is an example of a Collaboration Bus-invoked service.

    System InteractionsSystem Manager manages all the aspects of Collaboration Environment, includingadministration, management, and troubleshooting.

    Collaboration Environment inter operates with Session Manager 6.3, Communication Manager6.3.9, Scopia and Avaya Media Server.

    Traditional H.248 gateways are supported to provide access to the PSTN and to providesupport for H.323 and legacy endpoints. Connection to SIP service provider trunks is providedvia a Session Border Controller to Session Manager.

    Overview

    16 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Snap-insCollaboration Environment snap-ins interoperate with other Avaya products. For example, theWebRTC Snap-in works with the Avaya Session Border Controller for Enterprise.

    TopologyThe following diagram provides a high-level illustration of the components of an Avaya AuraCollaboration Environment solution.

    Topology

    Avaya Aura Collaboration Environment Overview and Specification August 2014 17

  • Feature description

    Software development kitCollaboration Environment includes a Software Development Kit (SDK) for Java developersto create their own collaboration services to run on the Collaboration Environment server. AnyJava programmer can build, test and deploy a custom service. No specializedtelecommunications expertise is needed.

    The Collaboration Environment SDK provides a rich set of developer collateral including codeexamples, video tutorials, online API documentation, and discussion forums.

    The Collaboration Environment SDK is hosted by DevConnect at http://www.avaya.com/CEdeveloper. It is provided in a single download package in the form of a zip file.

    Application Programming Interface

    The Collaboration Environment API gives programmers a way to quickly develop, test, anddeploy services that use the following methods:

    Call Methods The Call Methods allow a service to monitor or modify calls on behalf ofthe calling party (user making an outbound call) or called party (userreceiving a call). The Call methods include functions for allowing a call,blocking a call, redirecting a call to a different number, changing thepresented identity of a user and forking a call. The Call Methods alsoallow a service to place an outgoing call.

    Media ControlMethods

    The Media Control Methods allow a service to play an announcementto one or more participants on the call and to collect button press (DTMF)tones on the call.

    Send EmailMethods

    The Send Email Methods allow a service to send an email to one or morerecipients.

    Send TextMessage (SMS)Methods

    The Send Text Message Methods allow a service to send a text (SMS)message to one or more recipients.

    Create ConferenceMethods

    The Create Conference Methods allow a service to schedule or cancela video or audio conference using Scopia conferencing. Additionalconference management capabilities are also available via the Scopiamanagement API.

    Overview

    18 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    http://www.avaya.com/CEdeveloperhttp://www.avaya.com/CEdevelopermailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Data AccessMethods

    The Data Access Methods allow a service to readily access user,service, or global data from the provisioning database as administeredon System Manager. These methods also allow the CollaborationEnvironment service to access data from an external database (externalto Collaboration Environment, but may be in same VM or on samephysical server as Collaboration Environment) using the JavaPersistence API (JPA).

    Collaboration BusMethods

    The Collaboration Bus Methods allow services to asynchronouslycommunicate using a point-to-point model or a publish-subscribemodel.

    Logging andalarming Methods

    The Logging Methods allow a service to easily log events and errors. Aspart of snap-in alarming, the serviceability agent sends the snap-inalarms to System Manager. However, third party snap-ins do not reachAvaya.

    System StatusMethods

    The System Status Methods allow a service to access information onthe CE system status (System Overload Level).

    EventingFrameworkMethods

    The Collaboration Environment eventing framework methods sendnotifications for server and snap-in generated events. The framework ispre-populated with call events, speech search events and systemevents. Eventing allows snap-ins to produce and consume events. Thecomplete event repository can be viewed from the element manageruser interface.

    Sample services

    The Collaboration Environment SDK provides the following sample services. Use them asmodels, or to test that your system is correctly installed and configured. These sample servicesare not intended for general deployment.

    Hello World

    A test service intended for developers to use to verify that their Collaboration Environmentis working correctly. When either the calling or called party is associated with this service,the message Hello from CE displays on the called endpoint.

    Whitelist

    Routes incoming calls to the dialed user only if the calling number is on a whitelist ofnumbers designated for the user. If the calling number is not on the list, the call redirectsto an alternate number. The service accesses the whitelist database, but does notmanage it.

    Dynamic Team Formation

    Feature description

    Avaya Aura Collaboration Environment Overview and Specification August 2014 19

  • Sends an email or text message to a list of participants inviting them to join a conferencecall using their Scopia client. Recipients can join the conference simply by clicking thelink in the message.

    Multi-channel broadcast

    Sends a broadcast message by email, text message, or voice to a list of contacts.

    Click to Call

    Allows the user to enter the calling and called numbers on a webpage. A call is then madeto both the calling and the called party numbers, and those participants are joined togetherin a call. The snap-in displays the call progress on the user interface.

    Calling Policies

    Called party service plays announcements. The service allows the call to continue to theoriginal number, forks the call to other numbers, redirects the call to another number,drops the call with an announcement. The caller must use DTMF to select the options.

    Development environment and toolsCollaboration Environment supports the following development environment and build/packaging tools:

    Any Java IDE can be used to develop services. Eclipse is the IDE used and recommendedby the Avaya Collaboration Environment team.

    The SDK includes Maven tools to build and package services. Although the use of Mavenis not required to build and deploy services, it is the tool used and recommended by theAvaya Collaboration Environment team.

    An eclipse plug-in is available for the SDK.

    Connector ServicesCollaboration Environment includes several Connector Services that provide access toexternal host applications. These built-in Connector Services communicate over theCollaboration Bus with services that request them. Connector Services are available for:

    Email

    Clicka Tell SMS (Text Messaging)

    Scopia (conferencing)

    Eventing Framework

    Overview

    20 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Email

    The email connector allows services to send emails. The email connector is an email clientthat sends SMTP requests to one or more email hosts which in turn send the email. The emailconnector is a send-only email client. Services communicate with the email connector usingthe Collaboration Bus framework via an email API.

    The email API can handle a total of 10,000 recipients per request, which can be anycombination of primary, carbon-copy, or blind-copy recipients.

    Clicka Tell SMS (Text Messaging)

    The SMS Connector Service provides the capability to send, but not receive, SMS messages.The Collaboration Environment SMS connector Service uses the Clickatell HTTP-based SMSgateway. The SMS API provides the following parameters:

    Destination phone number

    Source phone number (Optional)

    User credentials (Optional)

    Message body (supports extended character sets)

    Note:You require a separate SMS service subscription from a public carrier or from another SMSservice provider.

    Scopia (conferencing)

    The Scopia connector uses the Conferencing API to access the Scopia Management Serverfor audio and video conferencing. The service can schedule a conference, cancel aconference, or retrieve a list of all active and scheduled conferences. Video conferences caninclude: video participants, audio-only participants, or a mixture of both.

    To support both video and audio-only participants, conference requests from the serviceinclude:

    A participant URL

    A host URL

    Dial-in phone number

    Meeting ID

    Feature description

    Avaya Aura Collaboration Environment Overview and Specification August 2014 21

  • Host code

    Participant code

    Eventing Framework

    The Eventing Framework connector allows remote systems to publish events into theCollaboration Environment Eventing Framework using REST web services. The publishersimply specifies the event family, type, metadata, and the message body. The EventingFramework then delivers the event to all the subscribers.

    ClustersClustering is the grouping of one or more Collaboration Environment servers that can bemanaged together. A Collaboration Environment cluster thus consists of one or moreCollaboration Environment servers. A Collaboration Environment server can belong to onlyone cluster at a time.

    A Collaboration Environment server must belong to a cluster to have snap-ins installed. Snap-in installation is at the cluster level. This implies that all the servers in a single cluster will havethe same snap-ins.

    You can have a maximum of 5 Collaboration Environment servers in a cluster and eachenterprise is allowed to have a maximum of 20 clusters.

    Cluster profilesA cluster profile is a preloaded template that contains cluster attributes. The cluster profilespecifies the fixed and variable attributes in a cluster. A set of cluster profiles are preloadedon the element manager. For every cluster profile there are a set of required snap-ins. Somecluster profiles may also have optional snap-ins. The required snap-ins are mandatory. Ensurethat all the required snap-ins are loaded. However, you can choose to install any of the optionalsnap-ins.

    General Purpose cluster profile: A General Purpose cluster is an open type cluster where youcan install any type of snap-in or service. The minimum number of servers for a generalpurpose cluster is 1.

    Product specific cluster profiles: Cluster profiles like Context Store profile or a WorkAssignment profile are product specific. These cluster profiles have a specified list of requiredand optional snap-ins that you can install. If you attempt to install an unlisted snap-in for thiscluster profile, the installation fails, and the system displays an error message.

    Clustering capabilitiesUse the clustering functionality to:

    Create a new cluster and assign a cluster profile to a cluster. The profile has configurationinformation, attribute definitions, and requirements of the cluster.

    Edit clusters and cluster attributes.

    Overview

    22 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Delete clusters Add or remove servers from a cluster. Install or remove snap-ins across instances in a cluster. Manage resources for logging. Select product specific cluster profiles like Context Store or Work Assignment.

    Data grid functionality for clustersCollaboration Environment supports data grid configuration on a cluster. The data grid isshared by all the servers in a cluster. If a server needs to find the data residing on anotherserver on the cluster, a Lookup service is required. The Lookup service is hosted on twodesignated Lookup servers in a cluster.

    Service ProfilesA Service Profile is an administered group of snap-ins. A snap-in can be administered to havedifferent service attributes for each specific Service Profile. Therefore, the same snap-in canbe tailored using the service attributes to meet the needs of different users or groups.

    A Service Profile can contain up to five Call Intercept services.

    For more information about Service Profiles, see Administering Avaya Aura CollaborationEnvironment.

    Preferred version of a snap-inCollaboration Environment provides an option to choose a preferred version of a snap-in. Theadministrator manages the preferred version of the snap-in. If you set the preferred version ofa snap-in for specific clusters, and install a newer version of the same snap-in, the service isnot disrupted. The Collaboration Environment instances continue to use the preferred versionof the snap-in. As an administrator, when you want to switch to the newer version of a snap-in, you can select the newer version as the preferred version.

    Note:

    If you have not installed the preferred version of a snap-in in a Collaboration Environmentcluster, the latest version is automatically chosen as the preferred version.

    You can set different versions of the same service as preferred for different clusters.

    Incoming and outgoing HTTP service invocationCollaboration Environment allows a snap-in to very easily expose both web pages and webservices to external browsers and applications. Collaboration Environment snap-ins haveaccess to the full suite of Java Enterprise Edition (JEE) classes and methods such as

    Feature description

    Avaya Aura Collaboration Environment Overview and Specification August 2014 23

  • HttpServlet. Additionally, an implementation of Jax-RS is included in CollaborationEnvironment so that developers can easily write RESTful web services. SOAP web servicescould be used if desired by including SOAP libraries such as Apache Axis in the WAR moduleand therefore in the Service Archive file.

    Developers do not need to concern themselves with routing of incoming HTTP requests totheir Collaboration Environment snap-in. When a Collaboration Environment snap-in isdeployed, the security module and the JEE container are automatically configured on thebehalf of the deployed snap-in, such that messages are correctly routed to the snap-in. Thisconfiguration ensures that any request sent to a URL of the form http(s):///services/ will cause the snap-in to be invoked. If multiple versions of asnap-in are deployed concurrently, the preferred version is invoked.

    In addition to allowing snap-ins to handle incoming HTTP requests, Collaboration Environmentsnap-ins can invoke external web services using the HTTP client library of their choice. ApacheHttpClient works well. If a service developer desires an interface tailored to REST invocation,Apache Wink is a possible solution. The Collaboration Environment installer allows the optionalconfiguration of an outbound HTTP proxy if snap-ins are invoking web services external to anenterprise firewall.

    In some cases you may have to provide the client certificate when you use a web servicesecured with HTTPS. Use Collaboration Environment to use the configured server certificateswhen you initiate outbound requests. For more information, see Javadoc for the classcom.avaya.collaboration.ssl.util.SSLUtilityFactory.

    System Manager Geographic Redundancy support forCollaboration Environment

    The Geographic Redundancy feature of System Manager consists of two System Managerservers located in geographically remote locations. The Geographic Redundancy featureensures that the management of enterprise communications remain unaffected during thefailure of a single System Manager server or during network failures.

    The Geographic Redundancy feature provides the following replication mechanisms to ensuredata synchronization between the primary System Manager server and the secondary SystemManager server:

    Database replication File replication

    In a system consisting of geographic redundant System Manager servers, the maincomponents include:

    Two System Manager servers located in geographically diverse locations. One SystemManager server is designated as the primary System Manager server. On a sunny day,the primary System Manager server manages all elements in the system. The otherSystem Manager server is designated as the secondary System Manager server. Thesecondary System Manager server remains in the standby mode. You can administer the

    Overview

    24 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • secondary server in the active mode if the primary System Manager server fails or losesconnectivity with the Collaboration Environment servers.

    Collaboration Environment servers.

    Important:In an environment of geographic redundant System Manager servers, both the primarySystem Manager server and the secondary System Manager server must reach each otherusing FQDN. FQDN must be reachable and resolvable through /etc/hosts or DNS.

    Before configuring Collaboration Environment in a geographic redundant environment,ensure that:

    Both the primary and the secondary System Manager servers can resolve theCollaboration Environment FQDN through /etc/hosts.

    The DNS server contains the IP address or the FQDN entry of all the CollaborationEnvironment servers that are configured with System Manager. This configurationensures that both the forward and the reverse lookups of Collaboration Environmentwork from both the primary and the secondary System Manager servers.

    The servers can reach each other using FQDN.

    The network with geographic redundancy operates in the following scenarios:

    Sunny day scenarioIn this case, the primary System Manager server manages all the Collaboration Environmentservers. The primary System Manager server replicates administration changes to all theCollaboration Environment servers. The secondary server is in the standby mode and youcannot make any administration changes using the secondary server.

    Rainy day scenarioIn this case, the secondary System Manager server manages all the CollaborationEnvironment servers. The secondary System Manager server replicates the administrationchanges to all the Collaboration Environment servers. The primary System Manager serverhas failed or has lost connectivity with the Collaboration Environment servers. The primaryserver is thus offline and you cannot make any administration changes using the primaryserver.

    Split-network scenarioIn this case, the system administrator administers the secondary System Manager server tothe active mode when the primary System Manager server is also in the active mode. Aconnectivity failure occurs in the network. Some Collaboration Environment servers cancommunicate only with the primary System Manager server while some CollaborationEnvironment servers can communicate only with the secondary System Manager server.However, some Collaboration Environment servers can communicate with the primary and thesecondary servers.

    Feature description

    Avaya Aura Collaboration Environment Overview and Specification August 2014 25

  • Caution:Do not make any administration change in a Collaboration Environment server during a split-network scenario.

    For more information on Geographic Redundancy, see Administering Avaya AuraCollaboration Environment

    Overview

    26 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Chapter 3: Interoperability

    Product compatibilityFor the latest and most accurate compatibility information, go to www.avaya.com/Support.

    Collaboration Environment requirementsCollaboration Environment requires a licensed VMware instance (standard edition or better)and the following versions of the VMware hypervisor and products: ESXi 5.0 and any of its updates

    Collaboration Environment is a single vAppliance package with the following characteristics:

    Operating system RHEL 6.2

    CPU Core(s) 4 floating cores

    CPU reservation 9600MHz = 4x2400MHz

    Memory reservation 6.0GB

    Storage reservation 300GB

    Shared NIC(s) Two at 1000 Mbps, used for management interface and securitymodule

    Note:All the Collaboration Environment servers in a cluster with data grid must have the samememory reservation.

    When you install Collaboration Environment snap-ins the requirements may increase.

    Avaya Aura Collaboration Environment Overview and Specification August 2014 27

    https://support.avaya.com/CompatibilityMatrix/Index.aspx

  • Avaya Media Server requirementsAvaya Media Server is a single vAppliance package with the following characteristics:

    Operating system RHEL 6.2

    CPU Core(s) 4 floating cores

    CPU reservation 9600MHz = 4x2400MHzMemory reservation 4.5GBStorage reservation 50GBShared NIC(s) One at 1000 Mbps

    Interoperability

    28 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Chapter 4: Performance specifications

    Capacity and scalability specification

    Collaboration Environment servers inan enterprise

    35

    Collaboration Environment users in anenterprise

    35,000

    Collaboration Environment clusters inan enterprise

    20

    Collaboration Environment servers in acluster

    5

    Busy Hour Calls per CollaborationEnvironment server

    50,000

    Busy Hour Email Notifications 50,000

    Busy Hour SMS Notifications 50,000

    Avaya Media Server instances 20

    Avaya Media Server ports per instance 1,024

    Avaya Media Server concurrentsessions

    A single instance of Avaya Media Serversupports:- 1000 concurrent sessions using the G.711

    codec- 830 concurrent sessions using the G.722 codec- 670 concurrent sessions using the G.729 codecSRTP adds 50% overhead (reduce abovenumbers by factor of 1.5).

    The number of supported sessions is subject tochange based on the results of furtherperformance testing.

    Avaya Aura Collaboration Environment Overview and Specification August 2014 29

  • Use the following formulas to calculate server requirements for standard availability.

    CE Virtual Servers 1 = ( Uci x BHC + 6 x SN x RPN ) / 50,000 rounded up2

    - Uci is the number of users involved in call intercept services.- BHC is the average number of calls per busy hour per user.

    5 is a good value for a high, general business/unified communication trafficlevel.

    20 is a good value for a high, contact center traffic level.- SN is the maximum number of simultaneous notifications within one 10 minute

    period.- RPN is the average number of recipients per notification.

    AMS Virtual Servers = SN x (Vp x RPN) / 2,000 rounded up3

    - AMS is only used to broadcast voice messages, detect and collect DTMF tones, andplay an announcement to the calling party.

    - AMS is NOT used in Dynamic team formation at this time.- Vp is the percentage of recipients being notified with a voice call (where 1.0 is

    100%).

    High availabilityCollaboration Environment can be deployed across multiple geographic locations with eachCollaboration Environment providing active service. To accomplish this, Session Manager islinked to the different Collaboration Environment instances and an FQDN is used to routeservice requests to the Collaboration Environment cluster.

    Note:The Collaboration Environment clusters can be located in different geographical locations.However, the Collaboration Environment servers in a particular cluster must be in the samelocation.

    Call Intercept services on Collaboration Environment are highly available, provided that two ormore Collaboration Environment instances have been provisioned as a cluster. All new callshandled by such services provide full feature functionality after a failure of a CollaborationEnvironment instance.

    If a Collaboration Environment server fails, any active calls that were originated or interceptedby that instance are impacted. The talk path on these existing calls is maintained, but you

    1 Virtual servers are configured with the recommended standard resource set, fully reserved.2 While the formula is not subject to change, the scaling constant (50,000) used here is a preliminary estimate. We may adjust

    it up or down based upon further testing and customer experience. Also, this assumes well written typical services. Serviceswhich use excessive resources (CPU or memory) or block for long (>5ms) time periods will reduce this constant (thusincreasing the number of servers required)

    3 While the formula is not subject to change, the scaling constant (2,000) used here is a preliminary estimate. We may adjustit up or down based upon further testing and customer experience.

    Performance specifications

    30 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • cannot apply any functionality to these calls by using Collaboration Environment snap-ins orother applications in the call path such as Communication Manager.

    For more information about administering Collaboration Environment high availability, seeDeploying Avaya Aura Collaboration Environment.

    High availability

    Avaya Aura Collaboration Environment Overview and Specification August 2014 31

  • Performance specifications

    32 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Chapter 5: Security

    Security specificationTrust and Identify certificatesCustomers can install their own or third-party Trust Certificates and Identity Certificates forclusters. Different certificates can be used for SIP and HTTP for traffic and the managementinterface.

    Security alert:To ensure the security of your system, Avaya strongly recommends that you replace theDemo certificates and the Avaya SIP CA certificate with:

    your own third-party certificates, or unique, individual certificates signed by the System Manager Trust Manager CA.

    HTTP securityIt is possible to optionally provision a list of trusted hosts that are authorized to invoke HTTPservices.

    IP Address

    If the source IP address for an incoming HTTP(S) request matches one specified in thetrusted host list, then the connection is accepted. If not, the connection is denied.

    Certificate-based

    If this mechanism is enabled, the HTTP Firewall / Front-End Proxy will challenge for aclient certificate and validate that certificate against its trusted CAs.

    If neither of these mechanisms is enabled, the HTTP Firewall / Front-End Proxy acceptsincoming connections from any host.

    Role Based Access Control (RBAC)Collaboration Environment supports RBAC for System Manager functions. This includes:

    Read and write access to all Collaboration Environment instances. Add, delete, modify and view access to each Collaboration Environment web page. The ability to load, install or uninstall or delete a service.

    Avaya Aura Collaboration Environment Overview and Specification August 2014 33

  • Port utilizationFor complete port matrix information, see the Port Matrix Documents section at http://support.avaya.com/security.

    Security

    34 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    http://support.avaya.com/securityhttp://support.avaya.com/securitymailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Chapter 6: Licensing Requirements

    Licensing requirementsCollaboration EnvironmentUse of the Collaboration Environment software requires a valid Collaboration Environmentlicense file.

    Collaboration Environment uses the Avaya Product Licensing and Delivery System (PLDS) tomanage license entitlements and to generate license files. The license file contains informationregarding the product, major release, license features and capacities. License files aredownloadable from PLDS and are installed on System Manager WebLM.

    In a network with multiple Collaboration Environment servers, only a single license file installedon System Manager WebLM is needed to license all the Collaboration Environment servers.

    Other license requirementsCollaboration Environment runs on a VMware environment that must be licensedindependently by the customer.

    Some Avaya snap-ins like WebRTC Snap-in, Context Store, Collaboration Designer, WorkAssignment require their own licenses files. You must download the license files from PLDSand install the license files on System Manager WebLM.

    Collaboration Environment platform licensingCollaboration Environment supports the platform licensing feature, where the CollaborationEnvironment element manager maintains the license mode for each CollaborationEnvironment instance. The possible license modes for a Collaboration Environment instanceare:

    License Normal Mode: A valid license file is installed. No license errors are found. Thecomplete functionality is available for the Collaboration Environment instance.

    License Error Mode: License error is seen in this mode. The Collaboration Environmentinstance is in a 30 day grace period during this mode. Complete functionality is available

    Avaya Aura Collaboration Environment Overview and Specification August 2014 35

  • during the grace period. The system displays the warning icon along with the grace periodin the License Mode column in the Server Administration page.

    License Restricted Mode: The Collaboration Environment instance goes in to therestricted mode after the 30 day grace period expires. The Collaboration Environmentinstance goes in to the Deny New Service mode.

    Platform license validationThe platform licensing feature also validates Collaboration Environment instances when youadd, delete, and start up a Collaboration Environment server. Each Collaboration Environmentserver needs a license. The number of Collaboration Environment servers cannot exceed thenumber of license files.

    If you administer a Collaboration Environment server beyond the license capacity, the servergoes into the License Error mode with a 30 day grace period.

    Licensing auditCollaboration Environment licensing audit runs every 9 minutes. Any license changes includinginstall or uninstall actions on the WebLM server takes time to reflect on the user interface. Thelatest license information thus takes a maximum of 9 minutes to reflect in the CollaborationEnvironment element manager.

    Licensing Requirements

    36 Avaya Aura Collaboration Environment Overview and Specification August 2014Comments? [email protected]

    mailto:[email protected]?subject=AvayaAura Collaboration Environment Overview and Specification

  • Index

    A

    API ..............................................................................18Avaya Media Server license requirements .................35

    B

    busy hour ....................................................................29calls ......................................................................29email notifications ................................................ 29SMS notifications ................................................. 29

    C

    call intercept service description ...........................13, 15call methods ............................................................... 18capacities ................................................................... 29Clicka Tell SMS .......................................................... 21Clickatell ..................................................................... 21clusters ....................................................................... 22clusters for high availability ........................................ 30collaboration bus methods ......................................... 18collaboration bus-invoked service description ............15Collaboration Environment ......................................... 35

    platform licensing .................................................35compatibility matrix .....................................................27component diagram ....................................................17conferencing ...............................................................21connector services .......................................... 13, 20, 21

    conferencing ........................................................ 21email .................................................................... 21overview ...............................................................20Scopia ..................................................................21SMS ..................................................................... 21text messaging .....................................................21

    Connectors ................................................................. 22Eventing Framework ............................................22

    CPU Core ............................................................. 27, 28Avaya Media Server .............................................28Collaboration Environment ...................................27

    CPU reservation ................................................... 27, 28Avaya Media Server .............................................28Collaboration Environment ...................................27

    create conference methods ........................................18

    D

    data access methods ................................................. 18

    Default version ........................................................... 23diagram of components ..............................................17documents ....................................................................7dynamic team formation ............................................. 19

    E

    Eclipse ........................................................................20email ...........................................................................21Eventing Framework .................................................. 22

    G

    geographic redundancy ..............................................24Collaboration Environment ...................................24

    H

    hello world .................................................................. 19Heterogenous clusters ............................................... 22high availability ........................................................... 30HTTP .................................................................... 23, 33

    incoming ...............................................................23security .................................................................33

    HTTP service invocation ............................................ 23HTTP-invoked service description ..............................15

    I

    identity certificates ................................................ 13, 33

    L

    license requirements .................................................. 35Avaya Media Server .............................................35Collaboration Environment ...................................35VMware ................................................................35

    Licensing .................................................................... 35Collaboration Environment ...................................35

    logging methods ......................................................... 18

    M

    Maven .........................................................................20media control methods ............................................... 18

    Avaya Aura Collaboration Environment Overview and Specification August 2014 37

  • memory reservation .............................................. 27, 28Avaya Media Server .............................................28Collaboration Environment ...................................27

    methods ......................................................................18multi-channel broadcast ............................................. 19

    N

    New features .............................................................. 14Release 3.0 ..........................................................14

    New in this release ..................................................... 14

    O

    operating system .................................................. 27, 28Avaya Media Server .............................................28Collaboration Environment ...................................27

    outbound calling service description .......................... 15

    P

    platform licensing ....................................................... 35port matrix .................................................................. 34Preferred version ........................................................23

    snap-in ................................................................. 23product compatibility ...................................................27product requirements ............................................27, 28

    Avaya Media Server .............................................28Collaboration Environment ...................................27

    R

    RBAC ......................................................................... 33related documentation ..................................................7release notes ..............................................................10role based access control ...........................................33

    S

    sample services ..........................................................19dynamic team formation .......................................19

    hello world ............................................................19multi-channel broadcast .......................................19whitelist ................................................................ 19

    Scopia ........................................................................ 21SDK ............................................................................ 18send email methods ................................................... 18send text message methods ...................................... 18server requirement calculations ................................. 29server requirements ................................................... 29service ........................................................................ 23

    preferred version ..................................................23service packs ..............................................................10service profile attributes ............................................. 23service profiles ........................................................... 23services .................................................................13, 15

    benefits ................................................................ 13call intercept description ...................................... 15collaboration bus-invoked description ..................15defined ................................................................. 13description ............................................................15HTTP-invoked description ....................................15outbound calling description ................................ 15types .................................................................... 15

    shared NIC ............................................................27, 28Avaya Media Server .............................................28Collaboration Environment ...................................27

    storage reservation ............................................... 27, 28Avaya Media Server .............................................28Collaboration Environment ...................................27

    support ....................................................................... 10system interactions .....................................................16system status methods ...............................................18

    T

    text messaging ........................................................... 21training ......................................................................... 9trust certificates .....................................................13, 33

    V

    videos ......................................................................... 10Collaboration Environment ...................................10

    VMware license requirements .................................... 35

    W

    Whats new .................................................................14Release 3.0 ..........................................................14

    whitelist .......................................................................19

    38 Avaya Aura Collaboration Environment Overview and Specification August 2014

    ContentsChapter1:IntroductionPurposeIntended audienceDocumentationTrainingCollaboration Environment videosSupportWarranty

    Chapter2:OverviewAvaya Aura Collaboration Environment overviewWhats new in the 3.0 releaseVMware deploymentService typesSystem Interactions

    TopologyFeature descriptionSoftware development kitApplication Programming InterfaceSample services

    Development environment and toolsConnector ServicesEmailClicka Tell SMS (Text Messaging)Scopia (conferencing)Eventing Framework

    ClustersService ProfilesPreferred version of a snap-inIncoming and outgoing HTTP service invocationSystem Manager Geographic Redundancy support for Collaboration Environment

    Chapter3:InteroperabilityProduct compatibilityCollaboration Environment requirementsAvaya Media Server requirements

    Chapter4:Performance specificationsCapacity and scalability specificationHigh availability

    Chapter5:SecuritySecurity specificationPort utilization

    Chapter6:Licensing RequirementsLicensing requirementsCollaboration Environment platform licensing

    Index


Recommended