Professional Documents
Culture Documents
Specification
Release 9.0
Issue 2
July 2020
© 2020, 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 Copyright
COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT Except where expressly stated otherwise, no use should be made of
YOU HAVE THE AUTHORITY TO BIND SUCH ENTITY TO THESE materials on this site, the Documentation, Software, Hosted Service,
TERMS OF USE. IF YOU DO NOT HAVE SUCH AUTHORITY, OR IF or hardware provided by Avaya. All content on this site, the
documentation, Hosted Service, and the product provided by Avaya result in substantial additional charges for your telecommunications
including the selection, arrangement and design of the content is services.
owned either by Avaya or its licensors and is protected by copyright
Avaya Toll Fraud intervention
and other intellectual property laws including the sui generis rights
relating to the protection of databases. You may not modify, copy, If You suspect that You are being victimized by Toll Fraud and You
reproduce, republish, upload, post, transmit or distribute in any way need technical assistance or support, call Technical Service Center
any content, in whole or in part, including any code and software Toll Fraud Intervention Hotline at +1-800-643-2353 for the United
unless expressly authorized by Avaya. Unauthorized reproduction, States and Canada. For additional support telephone numbers, see
transmission, dissemination, storage, and or use without the express the Avaya Support website: https://support.avaya.com or such
written consent of Avaya can be a criminal, as well as a civil offense successor site as designated by Avaya.
under the applicable law.
Downloading Documentation
Virtualization
For the most current versions of Documentation, see the Avaya
The following applies if the product is deployed on a virtual machine. Support website: https://support.avaya.com, or such successor site
Each product has its own ordering code and license types. Unless as designated by Avaya.
otherwise stated, each Instance of a product must be separately
licensed and ordered. For example, if the end user customer or Contact Avaya Support
Avaya Channel Partner would like to install two Instances of the See the Avaya Support website: https://support.avaya.com for
same type of products, then two products of that type must be product or Hosted Service notices and articles, or to report a problem
ordered. with your Avaya product or Hosted Service. For a list of support
Third Party Components telephone numbers and contact addresses, go to the Avaya Support
website: https://support.avaya.com (or such successor site as
“Third Party Components” mean certain software programs or designated by Avaya), scroll to the bottom of the page, and select
portions thereof included in the Software or Hosted Service may Contact Avaya Support.
contain software (including open source software) distributed under
third party agreements (“Third Party Components”), which contain Trademarks
terms regarding the rights to use certain portions of the Software The trademarks, logos and service marks (“Marks”) displayed in this
(“Third Party Terms”). As required, information regarding distributed site, the Documentation, Hosted Service(s), and product(s) provided
Linux OS source code (for those products that have distributed Linux by Avaya are the registered or unregistered Marks of Avaya, its
OS source code) and identifying the copyright holders of the Third affiliates, its licensors, its suppliers, or other third parties. Users are
Party Components and the Third Party Terms that apply is available not permitted to use such Marks without prior written consent from
in the products, Documentation or on Avaya’s website at: https:// Avaya or such third party which may own the Mark. Nothing
support.avaya.com/Copyright or such successor site as designated contained in this site, the Documentation, Hosted Service(s) and
by Avaya. The open source software license terms provided as Third product(s) should be construed as granting, by implication, estoppel,
Party Terms are consistent with the license rights granted in these or otherwise, any license or right in and to the Marks without the
Software License Terms, and may contain additional rights benefiting express written permission of Avaya or the applicable third party.
You, such as modification and distribution of the open source
software. The Third Party Terms shall take precedence over these Avaya is a registered trademark of Avaya Inc.
Software License Terms, solely with respect to the applicable Third All non-Avaya trademarks are the property of their respective owners.
Party Components to the extent that these Software License Terms Linux® is the registered trademark of Linus Torvalds in the U.S. and
impose greater restrictions on You than the applicable Third Party other countries.
Terms.
The following applies only if the H.264 (AVC) codec is distributed with
the product. THIS PRODUCT IS LICENSED UNDER THE AVC
PATENT PORTFOLIO LICENSE FOR THE PERSONAL USE OF A
CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE
REMUNERATION TO (i) ENCODE VIDEO IN COMPLIANCE WITH
THE AVC STANDARD (“AVC VIDEO”) AND/OR (ii) DECODE AVC
VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A
PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO
PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS
GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE.
ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA,
L.L.C. SEE HTTP://WWW.MPEGLA.COM.
Service Provider
THE FOLLOWING APPLIES TO AVAYA CHANNEL PARTNER’S
HOSTING OF AVAYA PRODUCTS OR SERVICES. THE PRODUCT
OR HOSTED SERVICE MAY USE THIRD PARTY COMPONENTS
SUBJECT TO THIRD PARTY TERMS AND REQUIRE A SERVICE
PROVIDER TO BE INDEPENDENTLY LICENSED DIRECTLY FROM
THE THIRD PARTY SUPPLIER. AN AVAYA CHANNEL PARTNER’S
HOSTING OF AVAYA PRODUCTS MUST BE AUTHORIZED IN
WRITING BY AVAYA AND IF THOSE HOSTED PRODUCTS USE
OR EMBED CERTAIN THIRD PARTY SOFTWARE, INCLUDING
BUT NOT LIMITED TO MICROSOFT SOFTWARE OR CODECS,
THE AVAYA CHANNEL PARTNER IS REQUIRED TO
INDEPENDENTLY OBTAIN ANY APPLICABLE LICENSE
AGREEMENTS, AT THE AVAYA CHANNEL PARTNER’S EXPENSE,
DIRECTLY FROM THE APPLICABLE THIRD PARTY SUPPLIER.
Preventing Toll Fraud
“Toll Fraud” is the unauthorized use of your telecommunications
system by an unauthorized party (for example, a person who is not a
corporate employee, agent, subcontractor, or is not working on your
company's behalf). Be aware that there can be a risk of Toll Fraud
associated with your system and that, if Toll Fraud occurs, it can
Contents
Chapter 1: Introduction............................................................................................................ 7
Purpose.................................................................................................................................. 7
Upgrade Advantage Preferred.................................................................................................. 7
Warranty................................................................................................................................. 7
Changes in this release........................................................................................................... 8
Chapter 2: Overview................................................................................................................. 9
About Avaya Control Manager.................................................................................................. 9
New in this release................................................................................................................ 15
Chapter 3: Features................................................................................................................ 17
Features............................................................................................................................... 17
Centralized management and administration........................................................................... 17
Role based permission engine................................................................................................ 20
Unified Communications administration................................................................................... 21
Unified Communication features....................................................................................... 21
Dialing plan management................................................................................................. 24
Messaging support.......................................................................................................... 24
Contact center administration................................................................................................. 25
Call Management System ............................................................................................... 25
Avaya IQ........................................................................................................................ 25
®
Avaya Aura Call Center Elite Multichannel....................................................................... 26
Avaya Interaction Center.................................................................................................. 26
®
Avaya Aura Contact Center............................................................................................ 26
Avaya Proactive Contact.................................................................................................. 28
®
Avaya Aura Workforce Optimization................................................................................ 28
®
Avaya one-X Agent........................................................................................................ 28
®
Avaya Oceana Solution.................................................................................................. 30
Templates............................................................................................................................. 31
Multiple location support........................................................................................................ 32
Multitenancy......................................................................................................................... 32
Dial plan specifications.......................................................................................................... 33
Conversation Sphere............................................................................................................. 33
Bulk Action portal.................................................................................................................. 34
Bulk skill assignment............................................................................................................. 35
User interface design............................................................................................................. 35
Localization support............................................................................................................... 37
Centralized license tracker (Enterprise only)............................................................................ 38
Support for SNMP messages................................................................................................. 38
Microsoft Active Directory integration (Enterprise only)............................................................. 39
Security Assertion Markup Language (SAML) authentication ................................................... 40
July 2020 4
Comments on this document? infodev@avaya.com
Contents
July 2020 5
Comments on this document? infodev@avaya.com
Contents
July 2020 6
Comments on this document? infodev@avaya.com
Chapter 1: Introduction
Purpose
This document describes the features, capabilities, product support, and specifications of Avaya
Control Manager. People who want to gain a high-level understanding of Control Manager
features, interoperability, and performance will find this document useful.
Warranty
For information about warranties for Avaya Control Manager, go to the Avaya support site at:
https://support.avaya.com/helpcenter/getGenericDetails?detailId=C20091120112456651010
July 2020 7
Comments on this document? infodev@avaya.com
Introduction
July 2020 8
Comments on this document? infodev@avaya.com
Chapter 2: Overview
July 2020 9
Comments on this document? infodev@avaya.com
Overview
July 2020 10
Comments on this document? infodev@avaya.com
About Avaya Control Manager
July 2020 11
Comments on this document? infodev@avaya.com
Overview
July 2020 12
Comments on this document? infodev@avaya.com
About Avaya Control Manager
Component Description
1 Control Manager Performs the business logic and programming between the end user
Application Server interface and the database as well as providing the security engine for
Control Manager.
2 Control Manager Provisions components from Control Manager with the different Avaya
Provisioning Server applications. The provisioning server integrates Control Manager with the
different Avaya applications through the various supported connectors to
provision information across the environment.
3 Control Manager Stores the Control Manager system configuration.
Database
4 Control Manager Web Integrates the web services that developers use for the Control Manager
Services provisioning server to add, delete, or modify configurations from within the
Avaya environment.
5 Control Manager Web Provides the management interface for access to all the features of
Portal Control Manager. The Web portal is used in a variety of scenarios ranging
from product-specific managements to overall suite management.
6 Control Manager Integrates and manages the Avaya applications.
Connectors
xCaaS
The key components for an xCaaS solution include those shown in the following diagram and
table:
July 2020 13
Comments on this document? infodev@avaya.com
Overview
Component Description
1 Control Manager Performs the business logic and programming between the end user
Application Server interface and the database as well as providing the security engine for
Control Manager.
2 Control Manager Provisions components from Control Manager with the different Avaya
Provisioning Server applications. The provisioning server integrates Control Manager with the
different Avaya applications through the various supported connectors to
provision information across the environment.
3 Control Manager Stores the Control Manager system configuration.
Database
4 Control Manager Web Integrates the web services that developers use for the Control Manager
Services provisioning server to add, delete, or modify configurations from within the
Avaya environment.
5 Control Manager Web Provides the management interface for access to all the features of
Portal Control Manager. The Web portal is used in a variety of scenarios ranging
from product-specific managements to overall suite management.
6 Billing Database Provides billing services for service providers when using Control
Manager Billing. This database is not used with Usage Metering
Collection.
7 Control Manager Integrates and manages the Avaya applications
Connectors
July 2020 14
Comments on this document? infodev@avaya.com
New in this release
July 2020 15
Comments on this document? infodev@avaya.com
Overview
July 2020 16
Comments on this document? infodev@avaya.com
Chapter 3: Features
Features
The following sections provide a brief description of the functionality of the features that Control
Manager provides in support for various Avaya products.
Control Manager provides:
• Centralized management and administration of all contact center applications.
• Personalized thin client application interface.
• Visual call flow designing and vector management.
• Role-based permissions and multi-tenancy support.
• Full Microsoft Active Directory integration with single sign-on (SSO) functionality (Enterprise
only).
July 2020 17
Comments on this document? infodev@avaya.com
Features
July 2020 18
Comments on this document? infodev@avaya.com
Centralized management and administration
July 2020 19
Comments on this document? infodev@avaya.com
Features
July 2020 20
Comments on this document? infodev@avaya.com
Unified Communications administration
With Control Manager Permission engine, administrators can utilize the following across the
Avaya Aura® environment:
• A “tailor made” permissions engine that allows control of each aspect of the application.
• Set up multi-tenancy support.
• Flexibility to filter users, VDNs, and skills based on each one of the users permissions.
July 2020 21
Comments on this document? infodev@avaya.com
Features
July 2020 22
Comments on this document? infodev@avaya.com
Unified Communications administration
July 2020 23
Comments on this document? infodev@avaya.com
Features
Control Manager also enables the creation of multi-ranged dial plans per location. Users can
decide multiple ranges to any entity they wish to manage:
• User can create “Location A” and “Location B”.
• Decide that for “Location A”, extensions will be assigned from numbers 1-12, 3004-3009,
3011-3200.
• Decide that for “Location B”, extensions will be assigned from numbers 13-200, 3010,
3201-3300.
Multi-Range assignment is supported for all managed contact center entities and Unified
Communication entities.
Messaging support
Control Manager supports the following across Avaya’s Unified Communication Messaging
solutions to manage the key messaging features:
• One point of administration of all messaging features on the same extension configuration
screen.
• Create, manage, and delete messaging subscribers automatically through Control Manager
LDAP Integration.
July 2020 24
Comments on this document? infodev@avaya.com
Contact center administration
Avaya IQ
Control Manager supports Avaya IQ integration. It has the following capabilities.
• Simple and Easy Administration of Avaya IQ Groups.
• Enables User and permissions management in Avaya IQ.
• Role-based permission control the Avaya IQ user access rights
July 2020 25
Comments on this document? infodev@avaya.com
Features
July 2020 26
Comments on this document? infodev@avaya.com
Contact center administration
Creating a user or an agent in the Control Manager user interface is provisioned to all selected
systems including Control Manager for Avaya Aura® Call Center Elite
1. Control Manager Web Interface sends a change skill request to the Windows Provisioning
Server service.
2. The Provisioning Server service receives the request and analyses the skill list. There are
Avaya Aura® Call Center Elite Skills and Avaya Aura® Contact Center Skills, so the
Provisioning Server service first updates Avaya Aura® Call Center Elite via the Control
Manager Library that is part of the provisioning process.
3. After a successful transaction (configurable, can work also in case of failure) the
provisioning process calls the Avaya Aura® Contact Center library that calls the Avaya
Aura® Contact Center middle tier web services directly from the Provisioning Server
service.
4. The Avaya Aura® Contact Center middle tier updates the Avaya Aura® Contact Center
“Environment”.
July 2020 27
Comments on this document? infodev@avaya.com
Features
July 2020 28
Comments on this document? infodev@avaya.com
Contact center administration
• Multiple client authentication modes support such as basic authentication, SSO, and mixed
• Hot-desking support
• Multiple domain support
• LDAP-based provisioning of users
Control Manager supports a tool for migration of data from the Avaya one-X® Agent Central
Management (CAM) database to the Control Manager Avaya one-X® Agent database. The
migration service is offered from Avaya Professional Services only. For more information about the
migration tool, contact Avaya Support.
Administration of Avaya one-X® Agent is part of the standard Control Manager offer and includes
the following components:
Component Description
Central Management A database that stores the configuration of Avaya one-X® Agent clients.
Database
Configuration Service A web service that communicates with Avaya one-X® Agent clients for
authentication, and retrieving and storing client data.
Administration Portal A web portal for administrators to manage the profiles of Avaya one-X® Agent
clients and other administrative parameters.
Avaya one-X® Agent administration from Control Manager also supports the following features:
• When the Avaya one-X® Agent log file reaches a certain size, the system creates another log
file to store the log information. The system creates a new log file after every 24 hours.
• For the Avaya one-X® Agent users who changed their template during their logged on period,
Control Manager administration of Avaya one-X® Agentprovides an option to determine
whether to prevent overriding the template changes with the client side values in the user
profile.
• While creating a new Avaya one-X® Agent template, if you specify a template name which is
already assigned to another template, the system displays an error message.
Note:
If the Avaya one-X® Agent template already has a contact list, you cannot create your own
standalone contacts through Avaya one-X® Agent administration on Control Manager. In this
case, you can use the softphone and add the standalone contacts through the work log.
For detailed information about Avaya one-X® Agent administration on Control Manager, see
Administering Avaya one-X® Agent Using Avaya Control Manager.
July 2020 29
Comments on this document? infodev@avaya.com
Features
1. The Avaya one-X® Agent client sends an HTTP request to the centralized admin web
service layer.
Note:
The web services can be distributed across the 1-N servers.
2. Each web service accesses the Control Manager database with the user’s credentials.
3. The database layer retrieves the entire configuration of the desired Agent.
4. The Avaya one-X® Agent client receives the configuration data as an XML file generated
by the application layer.
July 2020 30
Comments on this document? infodev@avaya.com
Templates
Templates
A Control Manager template is a predefined object configuration that can be used to create new
extensions, VDNs, skills, agents messaging users, Avaya Interaction Center users, Avaya Aura®
Contact Center users, and Avaya one-X® Agent users. Templates allow the administrator to
quickly and consistently administer objects on the Avaya systems. By default, the installation of
Control Manager software creates standard pre-defined templates for Communication Manager.
You can also create custom templates for new objects.
July 2020 31
Comments on this document? infodev@avaya.com
Features
Multitenancy
With the Control Manager Multitenancy feature, you can assign various objects, such as VDNs,
vectors, skills, agents, and more, to a tenant and provision them to the relevant Avaya system.
Assignation is based on the tenant’s administered location with Role Based Access Controls.
Multitenancy operates differently for different solutions.
For Enterprise deployments, Multitenancy depends on customer usage and expectations. For
example, with Multitenancy and RBAC, tenant boundaries are defined so that one tenant cannot
see the data of another tenant, if the system is properly configured. However, you cannot store
administration data in physically separate databases for each tenant.
For an xCaaS deployment, system transparency is maintained and customer privacy and security
is uncompromised. You can assign a user that is defined in Control Manager to specific tenants
that they can view, and this controls their ability to access the tenant-related objects. Consider the
following when using Multitenancy with xCaaS:
• An xCaaS instance is made up of the full lineup of products supported in the xCaaS
Reference Architecture.
• A single instance of the xCaaS solution supports a single customer, which is considered a
Dedicated Instance (DI), or Multiple customers, which is considered a Multi-tenant (MT)
Instance.
• A single MT instance can support up to 150 tenants.
• When using Usage Metering collection, Control Manager supports up to 15 xCaaS instances.
These instances can be a mix of DI and MT instances.
• A single xCaaS instance can support up to 4,000 concurrently logged-in agents or 20,000
extensions.
• For the overall capacities for Multitenancy, see Capacity and scalability specification on
page 87.
July 2020 32
Comments on this document? infodev@avaya.com
Dial plan specifications
Control Manager also supports the CMS Multitenancy feature for both Enterprise and xCaaS
deployments. You can assign users to different CMS tenants.
Same location
The ability to assign the same numbering to different entities is supported within the same
location.
Note:
“Next Available Number” functionality cannot be used within a single location if you want to
assign the same numbering to different entities.
The following table represents a valid dial plan even though there is overlapping numbering for
different objects, as long as “Next Available Number” is not used:
Location Agent Numbering VDN Numbering
1 1000 to 1500 1000 to 2000
If there is a requirement to use the “Next Available Number” functionality, unique numbering must
be used.
Location Agent Numbering VDN Numbering Notes
1 1000 to 1500 1000 to 2000 This is not valid
1 1000 to 1500 1501 to 2000 This is valid
Conversation Sphere
Control Manager Conversation Sphere is a Web-based designer studio that enables the users to
design processes within Control Manager. With Control Manager Conversation Sphere, users can
use a single flow to create the entire routing cycle between Experience Portal applications
(Enterprise only), Communication Manager vectors, and more.
July 2020 33
Comments on this document? infodev@avaya.com
Features
July 2020 34
Comments on this document? infodev@avaya.com
Bulk skill assignment
July 2020 35
Comments on this document? infodev@avaya.com
Features
Manager. For this release, the following Control Manager portals and screens have been
enhanced to support HTML 5 design:
• Configuration
• Media
• Bulk Action
• Reporting
• Role management Permissions tab
• License tracker
• Conversation Sphere
• Schedule
Also included is a Tile Pinning feature that users can use to create a shortcut to any Control
Manager portal, screen, and function. This is a powerful personalization feature providing faster
access and execution.
You can use the Location feature to filter one or more locations so that the system displays
information related only to the selected locations.
The following illustration shows the main components of the current Control Manager interface:
July 2020 36
Comments on this document? infodev@avaya.com
Localization support
Localization support
The Control Manager “tile design” user interface screens are supported for the following
languages:
• Simplified Chinese
• Traditional Chinese
• English
• French
• German
• Italian
• Japanese
• Korean
• Brazilian Portuguese
• Russian
• Latin American Spanish
The Control Manager software supports the following Windows operating systems:
• English
• German
• Japanese
Microsoft SQL Server database collation is supported for all supported user interface languages.
Control Manager has been tested with the following SQL Server level collation settings:
• English (SQL_Latin1_General_CP1_CI_AS)
• German (Latin1_General_CI_AS)
• Japanese (Japanese_CI_AS)
July 2020 37
Comments on this document? infodev@avaya.com
Features
For further information about the Control Manager Centralized License Tracker tool, see Using
Avaya Control Manager Central License and Traffic Tracker.
July 2020 38
Comments on this document? infodev@avaya.com
Microsoft Active Directory integration (Enterprise only)
The LDAP support in Control Manager is limited to Microsoft Windows Active Directory only.
The following features are enabled through Active Directory Provisioning:
• User Management – Manage user records and their permissions across the different
applications that Control Manager integrates with.
• Agent Management – Provision Agents into Communication Manager and related systems.
• Extension Management – Provision extensions into the Communication Manager based on
Control Manager Templates.
• Messaging Subscribers – Provision Messaging Subscribers into the Avaya Aura® Messaging
system based on templates.
• Synchronization – Support synchronization of users and agents from Microsoft Active
Directory so that users and agents are reflected in associated Control Manager and
Communication Manager systems.
Control Manager Integration to Active Directory is done through Active Directory Group Mapping
to the Control Manager object. Each Control Manager role can be mapped to a specific Active
Group and the group mapping between the Control Manager Roles and the Active Directory group
enables administrators to provision Users from Active directory directly into Control Manager and
all of the relevant Avaya systems within the environment.
July 2020 39
Comments on this document? infodev@avaya.com
Features
Within Control Manager each Extension Template can mapped to an Active Directory group. This
mapping enables the administration of extensions into the Communication Manager directly from
Active Directory.
Active Directory integration also enables the provisioning of Users/Agents into a specific part of an
organizational chart. This is achieved by mapping a specific Control Manager team to an Active
Directory group to facilitate the provisioning. Based on the mapping between an Active Directory
group and a Control Manager team, the Windows Provisioning Server service is able to provision
a user by the following means.
• Assigning the User to a team in the Control Manager Organization Chart.
• Provisioning the User to the relevant Avaya systems based on the assigned Location (the
Control Manager Team is assigned to a Control Manager Location Based Architecture in the
Control Manager Organization Chart).
July 2020 40
Comments on this document? infodev@avaya.com
Schedule Server service
To configure SAML authentication, you must enable SAML at the system level, define a SAML
Identity Provider server and the rules for connecting the Identity Provider, and configure Control
Manager users to use the SAML authentication type.
When you enable and configure SSO with SAML on Control Manager, you must use a specific
Web URL to connect to the Control Manager portal.
Using SAML for SSO is an advanced security function. Therefore, for the configuration, you must
have a good working knowledge of:
• Configuration and maintenance procedures of your Identity Provider server.
• Concepts of Security certificate.
• Use and management of Security certificate on the Windows and Identity Provider server
operating systems.
For detailed information about configuring Control Manager to support SAML SSO authentication,
see Configuring Avaya Control Manager.
July 2020 41
Comments on this document? infodev@avaya.com
Features
The Control Manager SOAP API was designed as an integral part of the Control Manager
Architecture and enables the management of users, agents, extensions, skills management, and
other key entities across the Avaya environment.
The Control Manager REST API (Web API) provides additional features to the Control Manager UI
that interacts with Control Manager. The REST API is an HTTP-based RESTful OData API that is
used to query, create, update, and delete data.
For more information about the SOAP API, see Using the Avaya Control Manager SOAP API. For
more information about the REST API, see Using the Avaya Control Manager REST API.
The Control Manager application server provides external system integration capabilities:
• Almost any system can be integrated to Control Manager.
• Standard SOAP or REST integration provides quick implementation.
• Managed integration from the Control Manager UI.
• Integration samples include Non-Avaya WFM systems and Recording systems.
Control Manager API also supports the use of Control Manager templates and profiles which you
can use to:
• Create an agent with the “default” settings including Control Manager Skills Management and
skill levels.
• Simplify the API usage by reducing the number of parameters to just 1.
The following is an example of the Control Manager API flow:
• The external application calls the Control Manager Web Services API.
July 2020 42
Comments on this document? infodev@avaya.com
Control Manager API and SDK (Enterprise and Avaya Oceana® Solution only)
• Authentication process. Every request that goes through the Control Manager API must use
a Control Manager user name and password for authentication. All the Control Manager roles
and permissions are also enforced on the API. So if your API user does not have permissions
to perform a certain operation, the user is rejected.
• If the authentication was successful, the request arrives at the application server.
• The application server transforms the request into the Windows Provisioning Server service
format.
• The Windows Provisioning Server service provisions the information into the relevant Avaya
systems.
• After the Windows Provisioning Server service successfully updates the integrated Avaya
systems, the Control Manager database is updated with the configuration change.
July 2020 43
Comments on this document? infodev@avaya.com
Features
For further information about the Control Manager API, see Using the Avaya Control Manager
SOAP API and Using the Avaya Control Manager REST API.
July 2020 44
Comments on this document? infodev@avaya.com
Visual Phone (Enterprise only)
July 2020 45
Comments on this document? infodev@avaya.com
Features
Reports portal
Control Manager has a new Reports portal that provides a user the ability to create administrative
reports based content that are stored within the Control Manager database. The reporting portal
provides the following key capabilities:
• Users can create and customize administrative reports utilizing “drag and drop” report
creation mechanisms.
• Users can save personal reports, share reports or create permissions to view.
• Reports can be grouped by; Sorted and Data can be summarized.
• Reports support both CSV and HTML formats
The Control Manager administrative reports include information such as:
• Users
• Roles and permissions
• Organizational structure
• Extensions
• Skills
• VDNs
July 2020 46
Comments on this document? infodev@avaya.com
Profile Manager Wizard
July 2020 47
Comments on this document? infodev@avaya.com
Features
Role cloning
Control Manager provides the ability to copy, modify and reuse existing roles saving considerable
time by removing the need to create a completely new role each time one is required.
Audit Log
With Audit Logging, changes within the Avaya environment get logged into an audit log table so
the entire change history of the environment is available for review.
There are three types of Audit Logs that are managed by Control Manager:
• System Audit Log – tracks all changes that are done on different entities within the system
including changes that are done directly within Communication Manager (through SAT).
• Control Manager Admin changes – shows changes that are done to administrative data
within Control Manager (Configuration section).
• Control Manager List History – shows all of the commands that have been run on the
Communication Manager system. Control Manager uses List History to get details about any
changes made directly on the Communication Manager system.
Users access the Audit Logs using the Audit Log Portal and every change that was made in the
environment will be shown in the audit log. The main audit log page displays the audited objects,
location, user that performed the change, and the time/date of the change.
July 2020 48
Comments on this document? infodev@avaya.com
Cut-through to Communication Manager system administration terminal (SAT)
July 2020 49
Comments on this document? infodev@avaya.com
Chapter 4: Interoperability
Product compatibility
For the latest Control Manager compatibility matrix, go to the following link on Avaya Support:
https://secureservices.avaya.com/compatibility-matrix/menus/product.xhtml?name=Control
+Manager
When to use Control Manager vs. System Manager
Avaya has established the following guidelines for when to use Control Manager and when to use
System Manager:
• In the Avaya Oceana® Solution, System Manager will be the platform for initial deployment of
Avaya Oceana® Solution components. Control Manager will be the platform for administration
of day-to-day contact center operations.
• In an xCaaS solution, Control Manager will be layered on top of System Manager to manage
the overall xCaaS environment.
• Use System Manager for Team Engagement (Unified Communications) solutions.
Communication Manager must be a managed element of the associated System Manager
deployment.
• Use Control Manager as an overlay to System Manager to manage Customer Engagement
(Contact Center) and agent management.
The following is a summary of the management usage, and whether the management solution is
mandatory or optional:
Usage Administration approach Comments
®
Avaya Oceana Solution Control Manager and System Both Control Manager and System
deployments Manager (both mandatory) Manager are always included in the
solution.
xCaaS deployments Control Manager and System Both Control Manager and System
Manager (both mandatory) Manager are always included in the
solution.
Table continues…
July 2020 50
Comments on this document? infodev@avaya.com
Software requirements
Software requirements
July 2020 51
Comments on this document? infodev@avaya.com
Interoperability
Related links
Operating system considerations on page 52
July 2020 52
Comments on this document? infodev@avaya.com
Software requirements
July 2020 53
Comments on this document? infodev@avaya.com
Interoperability
Important:
When installing Microsoft SQL Server 2012 or 2014 versions, ensure that the software build of
that version supports TLS 1.2. For information about hardware and software requirements of
Microsoft SQL Server 2016 and 2017, see the Microsoft documentation.
You must install the Microsoft SQL Server software on servers that are using the Microsoft
Windows Server operating system. You cannot use any other operating system software.
Important:
Create a user login ID on the Microsoft SQL database servers that are a full administrative
member of the Sysadmin server role. You can use this login ID during the installation of the
Control Manager software. Create the user login ID and the password and note these items
for later use. Use this login ID during installation only but not for the application during the
operation.
Important:
When creating database user passwords while installing the Microsoft SQL software or while
upgrading the Control Manager software, you must agree to use:
• Passwords that are 8-14 alphanumeric characters long.
• Passwords with upper case and lower case letters.
Do not use long and complex database passwords because of limitations with the Control
Manager installation software.
Express None
Express None
Enterprise Legacy HA
Express None
Enterprise Legacy HA
Express None
July 2020 54
Comments on this document? infodev@avaya.com
Software requirements
July 2020 55
Comments on this document? infodev@avaya.com
Interoperability
Certificate requirements
The Control Manager browser interface requires that the customer install signed certificates to
provide secure access (HTTPS). The signed certificates can be provided by a public or private
Certificate Authority (CA). To install certificates on the Control Manager servers, the servers must
have access to the CA. Self-signed certificates cannot be used in a production system.
The customer must install certificates on the Control Manager application servers (ACM-APP-1)
for All-in-One or Dual host.
The customer must install certificates on both Control Manager application servers in an HA
configuration (ACM-APP-1 and ACM-APP-2).
The customer must install certificates on both Control Manager UI servers (ACM-UI-1 and ACM-
UI-2).
Virtualization support
Avaya Control Manager operates on the following virtualized software platforms:
• VMware vSphere ESXi 6.7
• VMware vSphere ESXi 6.5
• VMware vSphere ESXi 6.0
July 2020 56
Comments on this document? infodev@avaya.com
Software requirements
Caution:
When using ESXi, ensure that the guest OS does not assign a new MAC address during
startup. If the host gets a new MAC address, it could cause the Control Manager license
service to not start and access to the Control Manager might fail.
Caution:
Control Manager software is not currently distributed using an Open Virtualization Archive
(OVA) file. Any older OVA files must be discarded and not used to install Control Manager
software. Verify that you have downloaded the latest version of Control Manager software,
which is provided as an ISO download.
July 2020 57
Comments on this document? infodev@avaya.com
Interoperability
July 2020 58
Comments on this document? infodev@avaya.com
Hardware and VMware requirement
11 Use this configuration to support an Enterprise single-box deployments. This configuration supports only Microsoft SQL
Server Express. This configuration does not support HA and not recommended for production deployment. This
configuration is suitable for trial or lab purposes.
12 Also known as Dual Host, the Non-HA footprint is backward compatible with Avaya Control Manager 8.0 for Oceana and
Enterprise customers. Enterprise Legacy Footprint will be removed in the future release.
July 2020 59
Comments on this document? infodev@avaya.com
Interoperability
Note:
For the above configurations, the virtualized machine and hardware requirements are nearly
the same. However, there are a few minor changes to the specifications. For more information
about footprint requirements for the Microsoft SQL Server database, refer to the product
documentation at https://docs.microsoft.com.
Related links
Optional load balancer server configuration on page 60
Microsoft SQL AlwaysOn server configuration on page 61
All-in-One application and database server configuration on page 62
Dual host server configuration on page 62
13 The Legacy HA footprint configuration uses a pair of application servers and a pair of database servers with standard
Microsoft SQL database software. Avaya will discontinue the Legacy HA support from the next release.
14 The Multiplex HA footprint is the go-forward and standard capacity configuration for enterprise deployments.
July 2020 60
Comments on this document? infodev@avaya.com
Hardware and VMware requirement
Multiplex HA feature. A software load balancer deployment uses a VMware server to host the load
balancer software and a pair of Control Manager application servers. The operating system
required for the load balancer VMware server depends on the software load balancer the
customer purchases.
The HAProxy load balancer is certified to operate with Control Manager. To install and configure
the HAProxy load balancer, go to the https://www.haproxy.com website, and check the product
documentation. Customers can deploy other load balancers in the same way as the HAProxy load
balancer. But Avaya has not tested other products to operate with Control Manager.
Note:
The HAProxy support is provided on a best-effort basis. Avaya does not assure that HAProxy
will be compatible with the future versions of Control Manager, as HAProxy is not a part of
Control Manager. You must download the HAProxy software separately.
The following table lists the minimum virtual server resource requirements for the software load
balancer server:
Processor 8 Core Processor
Memory 12 GB
Hard Disk 300 GB
15 IOPS is 3000 (average read + average write) requests per second. Ratio of average write-to-read is 19-to-1.
16 You must dedicate the application server for Control Manager software. You cannot install any other application software
on this server.
July 2020 61
Comments on this document? infodev@avaya.com
Interoperability
Note:
For the above configurations, the virtualized machine and hardware requirements are nearly
the same. However, there are a few minor changes to the specifications. For more information
about footprint requirements for the Microsoft SQL Server database, refer to the product
documentation at https://docs.microsoft.com.
Related links
Hardware and VMware requirement on page 59
Note:
For the above configurations, the virtualized machine and hardware requirements are nearly
the same. However, there are a few minor changes to the specifications. For more information
about footprint requirements for the Microsoft SQL Server database, refer to the product
documentation at https://docs.microsoft.com.
Related links
Hardware and VMware requirement on page 59
July 2020 62
Comments on this document? infodev@avaya.com
Supported endpoints
Note:
For the above configurations, the virtualized machine and hardware requirements are nearly
the same. However, there are a few minor changes to the specifications. For more information
about footprint requirements for the Microsoft SQL Server database, refer to the product
documentation at https://docs.microsoft.com.
Related links
Hardware and VMware requirement on page 59
Supported endpoints
Control Manager supports administration of the following endpoints:
July 2020 63
Comments on this document? infodev@avaya.com
Interoperability
July 2020 64
Comments on this document? infodev@avaya.com
Chapter 5: Reference configurations
July 2020 65
Comments on this document? infodev@avaya.com
Reference configurations
July 2020 66
Comments on this document? infodev@avaya.com
Optional software load balancer application server configuration
Note:
From this release of Control Manager administrator need not manually intervene in case of
fail-over and fail-back. If the primary application server (ACM-APP-1) fails then all the
independent services are running on (ACM-APP-1) will automatically switch to the secondary
application servers(ACM-APP-2) and secondary application server will become primary by
switching paused service into running state and vice versa.
For more information about recovering from this failure, see Maintaining and Troubleshooting
Avaya Control Manager.
The HAProxy load balancer (https://www.haproxy.com/) product has been certified to operate with
Control Manager. Other products can provide the same features. Required features include
session affinity and the ability to redirect user requests to alternate application servers in case of
failovers. It is up to the customer to decide which load balancer to use. Control Manager
documentation provides instructions for the HAProxy product, but many software load balancers
can be deployed in the same fashion.
July 2020 67
Comments on this document? infodev@avaya.com
Reference configurations
Note:
If a fail-over happens then it will be handled by Independent service component within Control
Manager, no manual intervention is required start the independent services on secondary
server.
July 2020 68
Comments on this document? infodev@avaya.com
Microsoft SQL AlwaysOn database server configuration
The SQL AlwaysOn feature is the recommended option with Control Manager.
July 2020 69
Comments on this document? infodev@avaya.com
Reference configurations
July 2020 70
Comments on this document? infodev@avaya.com
Multiplex HA 2x2 optional configuration — load balanced application servers and Microsoft SQL AlwaysOn database servers
July 2020 71
Comments on this document? infodev@avaya.com
Reference configurations
July 2020 72
Comments on this document? infodev@avaya.com
Multiplex HA 2x1 configuration — load balanced application servers and single SQL database server
July 2020 73
Comments on this document? infodev@avaya.com
Reference configurations
Legacy HA configurations
July 2020 74
Comments on this document? infodev@avaya.com
Legacy HA configurations
Control Manager software is installed on the primary application server (ACM-APP-1) and
secondary application server (ACM-APP-2).
The primary application servers represent the primary application logical layer. The secondary
application servers represent the secondary application logical layer. There are two Control
Manager SQL database servers (ACM-SQL-1/ACM-SQL-2) deployed in an Active/Active mode.
One of the Control Manager systems is designated as the primary and the other as the secondary.
Both Control Manager systems are completely active and work in parallel, and both of them
provide service simultaneously to administrative users.
In an HA configuration, a service failure, hardware, network, or database failure can initiate a
switchover if the following conditions are met:
• The primary and secondary Control Manager application servers are in a running state.
• Legacy HA is enabled on the Control Manager application servers.
• The Control Manager primary database server and secondary database server are
synchronized using either bidirectional or unidirectional replication.
- Bidirectional replication is used for Enterprise deployments that are not part of an Avaya
Oceana® Solution Geo Redundant HA deployment.
- Unidirectional replication is used for Enterprise deployments that are part of an Avaya
Oceana® Solution Geo Redundant HA deployment.
If the primary Control Manager application server fails and if the switchover conditions are met, a
complete server switchover occurs to the secondary Control Manager application server. The
seven mutually exclusive services (Audit Log, Sync, Schedule Server, and so on) on the
secondary server are started which carries the activity load during the outage.
July 2020 75
Comments on this document? infodev@avaya.com
Reference configurations
Note:
Footprint 3 can also be used in a lab environment to create a test two server deployment
without installing UM Collector software or VMware HA. This reduced configuration cannot be
used in a production environment.
The following architecture diagram illustrates a typical single data center using a Legacy HA
configuration.
Bidirectional
HA Server
Database
Heartbeat
Replication
LAN
Administrator
Avaya Product 1 Avaya Product N
July 2020 76
Comments on this document? infodev@avaya.com
Legacy HA configurations
Control Manager Legacy HA for xCaaS using Survivable ESS Communication Manager systems
leverages the transactional replication feature that is available in Microsoft SQL Standard Edition
or Enterprise Edition server software. This means is that, under normal operating conditions, any
change to any of the defined databases (ACM-SQL-1) will be automatically pushed out to the
corresponding database (ACM-SQL-2). However, the same does not apply in reverse: any change
made on the ACM-SQL-2 databases must be manually updated on the corresponding ACM-
SQL-1 database.
The following architecture diagram illustrates a typical dual data center using a Legacy HA
configuration.
July 2020 77
Comments on this document? infodev@avaya.com
Reference configurations
Data Center 1
LAN
Primary Primary
Control Manager Control Manager
Application Host Database Host
UniDirectional
HA Server WAN or Bidirectional
Heartbeat Database
Replication
Data Center 2
Secondary Secondary
Control Manager Control Manager
Application Host Database Host
LAN
Administrator
Avaya Product 1 Avaya Product N
July 2020 78
Comments on this document? infodev@avaya.com
Legacy HA configurations
• The Control Manager primary database server and secondary database server are
synchronized using either bidirectional or unidirectional replication.
- Bidirectional replication is used for Enterprise deployments that are not part of an Avaya
Oceana® Solution Geo Redundant HA deployment.
- Unidirectional replication is used for Enterprise deployments that are part of an Avaya
Oceana® Solution Geo Redundant HA deployment.
Using Legacy HA eliminates the need to manually duplicate the administration of a secondary
system. The systems can be within the data center or over a WAN.
Both the primary and secondary Control Manager Systems in a Legacy HA configuration have
identical deployments, providing full Control Manager capabilities.
Legacy HA is available with a single data center or a dual data center. However, for a dual data
center, the following network configuration must be in place:
• Equal to or greater than 1 Gbps bandwidth.
• Reliable network (no application level handling of network disconnects is provided).
• Latency:
- Less than or equal to 50 ms — Recommended.
- 50–100 ms — Some delays in navigation and simple operations. Complex operations, like
editing or saving SIP users that traverse multiple systems, may take substantially longer.
- 100–150 ms — Further performance degradation possible.
This latency information is provided as guidance. Actual performance will depend on the actual
network latency between Control Manager and the databases, between the Legacy HA database
pair, and between Control Manager and the managed systems.
Caution:
Host names of Control Manager application and UI servers must only contain alphabetic
letters and numbers and are limited to a length of 15 characters. Host names cannot contain
any special characters, such as hyphens (-) or underscores (_). Confirm that you are using a
valid host name before you install the Control Manager software because you cannot change
the host name after installing the Control Manager software.
Host names of Control Manager database servers must follow the requirements set forth by
Microsoft in the following article:
July 2020 79
Comments on this document? infodev@avaya.com
Reference configurations
https://support.microsoft.com/en-us/help/909264/
• For the supported Legacy HA deployments, the Control Manager functional components –
Web Server and Application Server – are all installed and deployed on the same server.
Separating these components to different servers is not a supported configuration.
• For the supported Legacy HA deployments, the Control Manager functional components –
Web Server and Application Server – are installed on different servers. On a Multiple host
configuration, the Web Server component is installed on a dedicated server (ACM-UI-1 and
ACM-UI-2), and the Application Server components are installed on another server (ACM-
APP-1 and ACM-APP-2).
• Control Manager Legacy HA is available only if the servers are installed using Microsoft SQL
Standard Edition or Enterprise Edition Server software.
• The Control Manager software version must be identical on both the primary and secondary
application servers.
• You have designated the primary and the secondary systems.
• Control Manager application servers work in parallel and communicate with the SQL servers
in an Active/Active setup.
• In an Active/Active deployment, Control Manager servers ACM-APP-1 (primary) and ACM-
APP-2 (secondary) use ACM-SQL-1 as their primary Control Manager SQL database.
• Control Manager Legacy HA must be configured only in a 1+1 configuration.
• Both the primary and secondary Control Manager application servers must have the same
hardware configuration.
• Both systems must be connected to the same sources. For example, the secondary system
must be connected to the same Communication Manager system as the primary.
• Both the primary and secondary systems must have SNMP alarming administered so that
alarms are sent from either system.
July 2020 80
Comments on this document? infodev@avaya.com
Legacy HA configurations
The following graphic shows an overview of the Control Manager HA configuration deployed with
a dedicated IP address.
July 2020 81
Comments on this document? infodev@avaya.com
Reference configurations
July 2020 82
Comments on this document? infodev@avaya.com
Legacy HA configurations
the primary database server (ACM-SQL-1) will be automatically pushed out to the databases on
the secondary database server (ACM-SQL-2). However, the same does not apply in reverse for
just the ACCCM database: any changes made to the ACCCM database on the secondary
database server (ACM-SQL-2) must be manually updated to the ACCCM database on the primary
database server (ACM-SQL-1); all other supported databases are updated using bidirectional
replication.
Control Manager Legacy HA for xCaaS deployments using Survivable ESS Communication
Manager systems leverages the unidirectional feature that is available in Microsoft SQL server
software. This means is that, under normal operating conditions, any change to the databases on
the primary database server (ACM-SQL-1) will be automatically pushed out to the databases on
the secondary database server (ACM-SQL-2). However, the same does not apply in reverse for
just the ACCCM database: any changes made to the ACCCM database on the secondary
database server (ACM-SQL-2) must be manually updated to the ACCCM database on the primary
database server (ACM-SQL-1); all other supported databases are updated using bidirectional
replication.
Per the reference architecture, the primary database connection path for the primary application
server (ACM-APP-1) and the secondary application server (ACM-APP-2) is to point to the same
primary database server (ACM-SQL-1). The secondary database connection path is for the
primary application server (ACM-APP-1) to point to the secondary database server (ACM-SQL-2).
Per the reference architecture, the primary database connection path for the primary UI server
(ACM-UI-1) and the secondary UI server (ACM-UI-2) is to point to the same primary database
server (ACM-SQL-1). The secondary database connection path is for the primary UI server (ACM-
UI-1) to point to the secondary database server (ACM-SQL-2).
Within a Control Manager Legacy HA environment, each Control Manager instance is working with
a dedicated database layer. The two Microsoft SQL database servers (ACM-SQL-1 and ACM-
SQL-2) host the following databases and are set up for transactional database replication.
The following table illustrates the replication strategy for each of the SQL databases that Control
Manager Legacy HA for Enterprise supports in a single or dual data center when not using a
Survivable ESS Communication Manager system.
Database Replication Direction
ACCCM Transactional Bidirectional
ACCCMONEXDB Transactional Bidirectional
ACCCMCMSYSLOG Transactional Bidirectional
ACCCMSYNC Transactional Bidirectional
The following table illustrates the replication strategy for each of the SQL databases that Control
Manager Legacy HA for Enterprise supports in a single or dual data center when using a
Survivable ESS Communication Manager system.
Database Replication Direction
ACCCM Transactional Unidirectional (DC 1
to DC 2 only)
Table continues…
July 2020 83
Comments on this document? infodev@avaya.com
Reference configurations
The following table illustrates the replication strategy for each of the SQL databases that Control
Manager Legacy HA for xCaaS supports in a dual data center when using a Survivable ESS
Communication Manager system.
Database Replication Direction
ACCCM Transactional Unidirectional (DC 1
to DC 2 only)
ACCCMCMSYSLOG Transactional Bidirectional
ACCCMSYNC Transactional Bidirectional
Note:
The ACCCMAVP database is not replicated.
Note:
The following table lists which database tables within the Control Manager databases do not
replicate:
Control Manager Database Tables
Database
ACCCM [Audit_Log_Service_Temp_InsertSource_Audit]
[CMAuditLogs_Temp]
[Extensions_Details_Temp]
[Extensions_Temp]
Log_Messages
[Skills_Temp]
[tmp_Traffic_Measure_Occupancy_History]
[tmp_Traffic_Measure_Trunks_History]
[VDNs_Temp]
ACCCMCMSYSLOG CM_Syslog_RawMessages_Temp
July 2020 84
Comments on this document? infodev@avaya.com
Reference configurations for xCaaS deployments
The primary purpose of HA is to ensure an uninterrupted data stream between Control Manager
and the associated Avaya applications. There are two methods for system switchover and failover:
Method Description
Manual Switchover Switches the role between the primary and secondary components. This
switchover type is typically used for planned maintenance activities.
Alternatively, you can manually switchover if a failure on a primary
component is not detected automatically.
Automatic Failover Automatic Failover is a process that enables the secondary components
to automatically take over the role of the primary components in the
event of a failure detected on the primary components. Automatic
Failover provides uninterrupted access to the system during a failure. HA
uses the HA Service (Heartbeat) to ensure automatic failover and does
not need manual switchover.
July 2020 85
Comments on this document? infodev@avaya.com
Reference configurations
Manager system using xCaaS. There will be no Control Manager failover since there is only
one set of servers. Any failover is handled by VMware HA. For more information, see
VMware HA documentation.
• For the more Legacy HA configuration, the primary application server represents the primary
application and UI logical layer. The secondary application server represents the secondary
application and UI logical layer. There are two Control Manager Microsoft SQL Server
database servers (ACM-SQL-1/ACM-SQL-2) deployed in an Active/Active mode.
Footprint 3 consists of the following servers:
• Primary application/UI server (ACM-APP-1) and primary database server (ACM-SQL-1)
installed on two virtual machines.
• Secondary application/UI server (ACM-APP-2) and secondary database server (ACM-SQL-2)
installed on two virtual machines.
Note:
Footprint 3 can also be used in a lab environment to create a test two server deployment
without installing UM Collector software or VMware HA. This reduced configuration cannot be
used in a production environment.
One of the Control Manager systems is designated as the Primary and the other as the
Secondary. Both Control Manager systems are completely active and work in parallel, and both of
them provide service simultaneously to administration users.
In a Legacy HA configuration, a data center or database failure can initiate a failover if the
following conditions are met:
• The primary and secondary Control Manager UI and application servers are in a running
state.
• HA is enabled on the Control Manager UI and services servers.
• The Control Manager primary database server and secondary database server are
synchronized using unidirectional replication.
July 2020 86
Comments on this document? infodev@avaya.com
Chapter 6: Performance specifications
July 2020 87
Comments on this document? infodev@avaya.com
Performance specifications
Standard capacity
Capacity Item Supported Capacity
Per instance Overall
Agents 10,000 150,000
Extensions 40,000 150,000
Skills 1,500 10,000
VDNs 4,500 60,000
Vectors 4,000 20,000
Announcements 1,000 10,000
Table continues…
July 2020 88
Comments on this document? infodev@avaya.com
Capacity and scalability specification
July 2020 89
Comments on this document? infodev@avaya.com
Chapter 7: Security
July 2020 90
Comments on this document? infodev@avaya.com
Port assignments
Port assignments
For Control Manager port assignments, see Avaya Control Manager Port Matrix available on the
Avaya support Web site at support.avaya.com.
July 2020 91
Comments on this document? infodev@avaya.com
Security
July 2020 92
Comments on this document? infodev@avaya.com
Chapter 8: Licensing requirements
Licensing requirements
Avaya provides a Web License Manager (WebLM) to manage licenses of one or more Avaya
software products for your organization. WebLM facilitates easy tracking of licenses. To track and
manage licenses in an organization, WebLM requires a license file from the Avaya Product
Licensing and Delivery System (PLDS) website at support.avaya.com through PLDS.
Control Manager 9.0 supports the integration of WebLM and the configuration of WebLM Server.
July 2020 93
Comments on this document? infodev@avaya.com
Licensing requirements
July 2020 94
Comments on this document? infodev@avaya.com
License compliance and enforcement using WebLM
July 2020 95
Comments on this document? infodev@avaya.com
Licensing requirements
Related links
License compliance and enforcement using WebLM on page 93
Restricted mode
Control Manager enters the Restricted mode once the Grace mode expires without addressing the
licensing problem. Users cannot log into the Control Manager system and the Provisioning Service
July 2020 96
Comments on this document? infodev@avaya.com
WebLM license modes
does not start when the system is in the Restricted mode. See Maintaining and Troubleshooting
guide for how to recover from Restricted mode.
July 2020 97
Comments on this document? infodev@avaya.com
Licensing requirements
Note:
For a new installation, all connectors and features works until the Grace mode period expires.
When the system moves to the Grace mode, administrators see a warning messages indicating
about the number of days left in Grace mode. This mode continues until you configure a valid
WebLM server with correct Control Manager license. If you do not install a new license, you
cannot to log on to the system after the Grace period expires.
July 2020 98
Comments on this document? infodev@avaya.com
Viewing WebLM licenses
July 2020 99
Comments on this document? infodev@avaya.com
Chapter 9: Resources
Documentation
The following table lists the documents related to this product. Download the documents from the
Avaya Support website at http://support.avaya.com.
Title Description
Overview
Avaya Control Manager Overview and This document describes the features and specifications for the
Specification Control Manager product.
Planning
Planning for an Avaya Control This document describes the planning and prerequisites that
Manager Deployment (formerly known customers must follow before deploying Control Manager.
as Avaya Control Manager Customer
Requirements)
New Installations
Installing Avaya Control Manager for This document describes how to install, configure, and test a
Enterprise - Non-High Availability non-HA Enterprise Control Manager system.
Installing Avaya Control Manager for This document describes how to install, configure, and test an
Enterprise - Multiplex High Availability Enterprise Control Manager system that is using Microsoft SQL
AlwaysOn for database server high availability and multiple
Control Manager application servers for high availability, along
with an optional deployment of a software load balancer.
Installing Avaya Control Manager for This document describes how to install, configure, and test a
Enterprise - Legacy High Availability Legacy HA Enterprise Control Manager system.
Upgrades
Upgrading to Avaya Control Manager This document describes how to upgrade a non-HA Enterprise
9.0 for Enterprise - Non-High Control Manager system from an earlier release to the current
Availability release. The document includes upgrade checklist, upgrade
procedures, and verification procedures for each supported
upgrade path.
Table continues…
Title Description
Upgrading to Avaya Control Manager This document describes how to upgrade an Enterprise Control
9.0 for Enterprise - Multiplex High Manager system from an earlier release to a system that is using
Availability Microsoft SQL AlwaysOn for database server high availability
and multiple Control Manager application servers for high
availability, along with an optional deployment of a software load
balancer. The document includes upgrade checklist, upgrade
procedures, and verification procedures for each supported
upgrade path.
Upgrading to Avaya Control Manager This document describes how to upgrade a Legacy HA
9.0 for Enterprise - Legacy High Enterprise Control Manager system from an earlier release to the
Availability current release. The document includes upgrade checklist,
upgrade procedures, and verification procedures for each
supported upgrade path.
Configuration
Configuring Avaya Control Manager This document describes how to configure Control Manager to
work with other Avaya products.
Avaya Control Manager Release This document contains any special release information, upgrade
Notes steps, and known issues.
Avaya Control Manager Port Matrix This document describes the port usage for Control Manager.
Administration
Using Avaya Control Manager to This document describes how to use Control Manager to
Administer Avaya Products administer features on Avaya products.
Administering Avaya one-X® Agent This document describes how to use Control Manager to
Using Avaya Control Manager administer Avaya one-X® Agent.
Administering an Avaya Experience This document describes how to use Control Manager with an
Portal Sample Application Using Experience Portal.
Avaya Control Manager
Administering Avaya Control Manager This document describes how to use Control Manager to
for Avaya Agent for Desktop administer Avaya Agent for Desktop.
Events and Alarms
Avaya Control Manager Events, This document describes the SNMP notifications for Control
Alarms, and Errors Reference Manager.
Using
Using Avaya Control Manager This document describes how to use Control Manager
Conversation Sphere Conversation Sphere to administer vectors, strategies, and call
flows.
Using Avaya Control Manager Central This document describes how to use Control Manager Central
License and Traffic Tracker License and Traffic Tracker.
Maintenance and Troubleshooting
Maintaining and Troubleshooting This document describes maintenance procedures and
Avaya Control Manager troubleshooting scenarios for Control Manager.
Documents to be downloads from the support site
Table continues…
Title Description
Using the Avaya Control Manager This document describes how to use the SOAP version of the
SOAP API Control Manager API.
Using the Avaya Control Manager This document describes how to use the REST version of the
REST API Control Manager API.
7. Click Enter.
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.
Training
The following courses are available on the Avaya Learning website at www.avaya-learning.com.
After logging into 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
Technical Design
3320W Avaya Customer Engagement Platforms Overview (includes Avaya Control
Manager Product Information Documents (PIDs))
3330W Avaya Customer Engagement Administration and Applications Overview
(includes Avaya Control Manager PIDs)
3420W Avaya Oceana® Solution Design Fundamentals (includes Avaya Control Manager
PIDs)
3371T APDS Avaya Customer Engagement Solutions Online Test
3470T Avaya Oceana® Solution Design Fundamentals Online Test
Technical Services
2092W Configuring Avaya Control Manager for Cloud Service Providers
2092T Avaya Control Manager Instance Configuration and Administration Test for Cloud
Service Providers
5307T Avaya Control Manager Implementation and Support Test for Cloud Service
Providers
70920W Installing Avaya Control Manager
7093W Upgrading and Supporting Avaya Control Manager for Cloud Service Providers
70940W Configuring Avaya Control Manager for Enterprise
70950W Upgrading and Supporting Avaya Control Manager for Enterprise
70910W Administering Avaya Control Manager for Enterprise
7091T Administering Avaya Control Manager R8 Online Test
5306 Avaya Control Manager Implementation and Support Test
24310W Administering Avaya Analytics™ for Oceana®
24320W Administering Avaya Oceana® Solution
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.
L R
languages ............................................................................ 37 reference configuration ........................................................ 85
legacy HA deployments ....................................................... 74 about .............................................................................65
legacy HA requirements ...................................................... 79 legacy HA deployments ................................................74
license compliance and enforcement using WebLM ............93 software load balancer ................................................. 66
license modes SQL AlwaysOn ............................................................. 69
error mode .................................................................... 96 related documentation ....................................................... 100
normal mode .................................................................96 replication ............................................................................ 82
restricted mode .............................................................96 reports portal ........................................................................46
license tracker ......................................................................38 requirements
licensing requirements .........................................................93 all-in-one server configuration ...................................... 62
load balancer configuration ..................................................66 client Web browser ....................................................... 55
localization ........................................................................... 37 database software ........................................................ 53
hardware .......................................................................59
Java Runtime Environment .......................................... 56
M load balancer configuration .......................................... 60
management operating system .......................................................... 51
centralized .................................................................... 17 resource management
media distribution portal .............................................................................46
portal .............................................................................47 role based permissions ........................................................20
web based .................................................................... 47 role cloning .......................................................................... 48
messaging
support ..........................................................................24 S
Microsoft active directory ..................................................... 39
Microsoft SQL AlwaysOn configuration ......................... 70, 72 SAML SSO authentication ................................................... 40
multiple location schedule server service
support ..........................................................................32 task scheduler .............................................................. 41
Multiplex HA searching for content ......................................................... 103
dual data center ............................................................74 security features .................................................................. 90
multitenancy .........................................................................32 sharing content .................................................................. 103
My Docs .............................................................................103 single application server configuration .................................72
single data center ................................................................ 75
SNMP .................................................................................. 38
N software load balancer ...................................................71, 73
new features ........................................................................ 15 software load balancer configuration ................................... 66
SQL AlwaysOn .................................................................... 71
SQL AlwaysOn configuration ...............................................69
O support .........................................................................40, 105
supported endpoints ............................................................ 63
on-boarding ..........................................................................47
switchover ............................................................................84
one-X Agent
integration .....................................................................29
operating system support .................................................... 37 T
OS considerations ............................................................... 52
overview .................................................................................9 templates ............................................................................. 31
third-party applications .........................................................55
TLS support ......................................................................... 57
P training ............................................................................... 104
password rules
password rules management ....................................... 91 U
performance .........................................................................87
permission engine ..........................................................20, 91 unified communication
V
videos ................................................................................ 105
virtualization support ............................................................56
visual phone .........................................................................44
Visual Phone ........................................................................63
W
warranty ................................................................................. 7
watch list ............................................................................ 103
WebLM features ...................................................................93
WebLM license modes .........................................................96
what’s new ........................................................................... 15
Windows OS and SQL combinations ...................................54
workforce optimization ......................................................... 28