Avaya CMS Instruction Manual
Installing Avaya CMS Connectors
Release 1.0
Issue 1
March 2017
Installing Avaya CMS Connectors March 2017 2
© 2015-2016 Avaya Inc.
All Rights Reserved.
Notice
While reasonable efforts have been made to ensure that the
information in this document is complete and accurate at the time
of printing, Avaya assumes no liability for any errors. Avaya
reserves the right to make changes and corrections to the
information in this document without the obligation to notify any
person or organization of such changes.
Documentation disclaimer
“Documentation” means information published by Avaya in varying
mediums which may include product information, operating
instructions and performance specifications that Avaya may
generally make available to users of its products and Hosted
Services. Documentation does not include marketing materials.
Avaya shall not be responsible for any modifications, additions, or
deletions to the original Published version of documentation
unless such modifications, additions, or deletions were performed
by Avaya. End User agrees to indemnify and hold harmless Avaya,
Avaya's agents, servants and employees against all claims, lawsuits,
demands and judgments arising out of, or in connection with,
subsequent modifications, additions or deletions to this
documentation, to the extent made by End User.
Link disclaimer
Avaya is not responsible for the contents or reliability of any linked
websites referenced within this site or documentation provided by
Avaya. Avaya is not responsible for the accuracy of any
information, statement or content provided on these sites and
does not necessarily endorse the products, services, or information
described or offered within them. Avaya does not guarantee that
these links will work all the time 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 limited warranty. In addition, Avaya’s standard warranty
language, as well as information regarding support for this product
while under warranty is available to Avaya customers and other
parties through the Avaya Support website:
http://support.avaya.com or such successor site as designated by
Avaya. Please note that if you acquired the product(s) from an
authorized Avaya Channel
Partner outside of the United States and Canada, the warranty is
provided to you by said Avaya Channel Partner and not by Avaya.
HostedService
THE FOLLOWING APPLIES IF YOU PURCHASE A HOSTED SERVICE
SUBSCRIPTION FROM AVAYA OR AN AVAYA CHANNEL PARTNER (AS
APPLICABLE), THE TERMS OF USE FOR HOSTED SERVICES ARE
AVAILABLE ON THE AVAYA WEBSITE,
HTTP://SUPPORT.AVAYA.COM/ LICENSEINFO UNDER THE LINK
“Avaya Terms of Use for Hosted Services” OR SUCH SUCCESSOR
SITE AS DESIGNATED BY AVAYA, AND ARE APPLICABLE TO ANYONE
WHO ACCESSES OR USES
THE HOSTED SERVICE. BY ACCESSING OR USING THE HOSTED
SERVICE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF
OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE DOING SO
(HEREINAFTER REFERRED TO INTERCHANGEABLY AS “YOU” AND
“END USER”), AGREE TO THE TERMS OF USE. IF YOU ARE
ACCEPTING THE TERMS OF USE ON BEHALF A COMPANY OR
OTHER LEGAL ENTITY, YOU REPRESENT THAT YOU HAVE THE
AUTHORITY TO
BIND SUCH ENTITY TO THESE TERMS OF USE. IF YOU DO NOT HAVE
SUCH AUTHORITY, OR IF YOU DO NOT WISH TO ACCEPT THESE
TERMS OF USE, YOU MUST NOT ACCESS OR USE THE HOSTED
SERVICE OR AUTHORIZE ANYONE TO ACCESS OR USE THE HOSTED
SERVICE. YOUR USE OF THE HOSTED SERVICE SHALL BE LIMITED BY
THE NUMBER AND TYPE OF LICENSES PURCHASED UNDER YOUR
CONTRACT FOR THE HOSTED SERVICE, PROVIDED, HOWEVER,
THAT FOR CERTAIN HOSTED SERVICES IF APPLICABLE, YOU MAY
HAVE THE OPPORTUNITY TO USE FLEX LICENSES, WHICH WILL BE
INVOICED ACCORDING TO ACTUAL USAGE ABOVE THE CONTRACT
LICENSE LEVEL. CONTACT AVAYA OR AVAYA’S CHANNEL PARTNER
FOR MORE INFORMATION ABOUT THE LICENSES FOR THE
APPLICABLE HOSTED SERVICE, THE AVAILABILITY OF ANY FLEX
LICENSES (IF APPLICABLE), PRICING AND BILLING INFORMATION,
AND OTHER IMPORTANT INFORMATION REGARDING THE HOSTED
SERVICE.
Support Tools:
“AVAYA SUPPORT TOOLS”MEAN THOSE SUPPORT TOOLS
PROVIDED TO PARTNERS OR CUSTOMERS IN CONNECTION WITH
MAINTENANCE SUPPORT OF AVAYA EQUYIPMENT (E.G., SAL, SLA
MON, AVAYA DIAGNOISTIC SERVER, ETC.) AVAYA SUPPORT TOOLS
ARE INTENDED TO BE USED FOR LAWFUL DIAGNOSTIC AND
NETWORK INTEGRITY PURPOSES ONLY. The customer is
responsible for understanding and complying with applicable legal
requirements with regard to its network. The Tools may contain
diagnostic capabilities that allow Avaya, authorized Avaya partners,
and authorized customer administrators to capture packets, run
diagnostics, capture key strokes and information from endpoints
including contact lists, and remotely control and monitor end-user
devices. The customer is responsible for enabling these diagnostic
Installing Avaya CMS Connectors March 2017 3
capabilities, for ensuring users are aware of activities or potential
activities and for compliance with any legal requirements with
respect to use of the Tools and diagnostic capabilities on its
network, including, without limitation, compliance with laws
regarding notifications regarding capture of personal data and call
recording.
Licenses
THE SOFTWARE LICENSE TERMS OR SUPPORT TOOLS LICENSE
TERMS AVAILABLE ON THE AVAYAWEBSITE,
HTTP://SUPPORT.AVAYA.COM/LICENSEINFO
OR SUCH SUCCESSOR SITE AS DESIGNATED BY AVAYA, ARE
APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR
INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC., ANY
AVAYA AFFILIATE, OR AN AVAYA CHANNEL PARTNER (AS
APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYA
OR AN AVAYA CHANNEL PARTNER. UNLESS OTHERWISE AGREED
TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTEND THIS LICENSE
IF THE SOFTWARE WAS OBTAINED FROM ANYONE OTHER THAN
AVAYA, AN AVAYA AFFILIATE OR AN AVAYA CHANNEL PARTNER;
AVAYA RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU
AND ANYONE ELSE USING OR SELLING THE SOFTWARE WITHOUT A
LICENSE. BY INSTALLING, DOWNLOADING OR USING THE
SOFTWARE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON
BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE
INSTALLING, DOWNLOADING OR USING THE SOFTWARE
(HEREINAFTER REFERRED TO INTERCHANGEABLY AS “YOU” AND
“END USER”), AGREE TO THESE TERMS AND CONDITIONS AND
CREATE A BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR
THE APPLICABLE
AVAYA AFFILIATE (“AVAYA”).
Avaya grants you a license within the scope of the license types
described below, with the exception of Heritage Nortel Software
and Support Tools, for which the scope of the license is detailed
below Where the order documentation does not expressly identify
a license type, the applicable license will be a Designated System
License. The applicable number of licenses and units of capacity for
which the license is granted will be one (1), unless a different
number of licenses or units of capacity is specified in the
documentation
or other materials available to you. “Designated Processor” means
a single stand-alone computing device. “Server” means a
Designated Processor that hosts a software application to be
accessed by multiple users.
License type(s)
Designated System(s) License (DS). End User may install and use
each copy or an Instance of the Software only on a number of
Designated Processors up to the number indicated in the order.
Avaya may require the Designated Processor(s) to be identified in
the order by type, serial number, feature key, Instance, location or
other specific designation, or to be provided by End User to Avaya
through electronic means established by Avaya specifically for this
purpose.
Concurrent User License (CU). End User may install and use the
Software on multiple Designated Processors or one or more
Servers, so long as only the licensed number of Units are accessing
and using the Software at any given time. A “Unit” means the unit
on which Avaya, at its sole discretion, bases the pricing of its
licenses and can be, without limitation, an agent, port or user, an
e-mail or voice mail account in the name of a person or corporate
function (e.g., webmaster or helpdesk), or a directory entry in the
administrative database utilized by the Software that permits one
user to interface with the Software. Units may be linked to a
specific, identified Server or an Instance of the Software.
Database License (DL). End User may install and use each copy or
an Instance of the Software on one Server or on multiple Servers
provided that each of the Servers on which the Software is
installed communicates with no more than an Instance of the
same database.
CPU License (CP). End User may install and use each copy or
Instance of the Software on a number of Servers up to the number
indicated in the order provided that the performance capacity of
the Server(s) does not exceed the performance capacity specified
for the Software. End User may not re-install or operate the
Software on Server(s) with a larger performance capacity without
Avaya’s prior consent and payment of an upgrade fee.
Named User License (NU). You may: (i) install and use the Software
on a single Designated Processor or Server per authorized Named
User (defined below); or (ii) install and use the Software on a
Server so long as only authorized Named Users access and use the
Software. “Named User”, means a user or device that has been
expressly authorized by Avaya to access and use the Software. At
Avaya’s sole discretion, a “Named User” may be, without
limitation, designated by name, corporate function (e.g.,
webmaster or helpdesk), an e-mail or voice mail account in the
name of a person or corporate function, or a directory entry in the
administrative database utilized by the Software that permits one
user to interface with the Software.
Shrinkwrap License (SR). You may install and use the Software in
accordance with the terms and
conditions of the applicable license agreements, such as
“shrinkwrap” or “clickthrough” license accompanying or applicable
to the Software (“Shrinkwrap License”).
Installing Avaya CMS Connectors March 2017 4
Heritage Nortel Software
“Heritage Nortel Software” means the software that was acquired
by Avaya as part of its purchase of the Nortel Enterprise Solutions
Business in December 2009. The Heritage Nortel Software
currently available for license from Avaya is the software contained
within the list of Heritage Nortel Products located at
http://support.avaya.com/LicenseInfo/ under the link “Heritage
Nortel Products”, or such successor site as designated by Avaya.
For Heritage Nortel Software, Avaya grants Customer a license to
use Heritage
Nortel Software provided hereunder solely to the extent of the
authorized activation or authorized usage level, solely for the
purpose specified in the Documentation, and solely as embedded
in, for execution on, or (in the event the applicable Documentation
permits installation on non-Avaya equipment) for communication
with Avaya equipment. Charges for Heritage Nortel Software may
be based on extent of activation or use authorized as specified in
an order or invoice.
Support Tools: Avaya Support Tools are provided as an
entitlement of Avaya Support Coverage (e.g., maintenance) and
the entitlements are established by Avaya. The scope of the
license for each Tool is described in its License terms and/or the
applicable service description document.
Copyright
Except where expressly stated otherwise, no use should be made
of materials on this site, the Documentation, Software, Hosted
Service, or hardware provided by Avaya. All content on this site,
the documentation, Hosted Service, and the Product provided by
Avaya including the selection, arrangement and design of the
content is owned either by Avaya or its licensors and is protected
by copyright and other intellectual property laws including the sui
generis rights relating to the protection of databases. You may
not modify, copy, reproduce, republish, upload, post, transmit or
distribute in any way any content, in whole or in part, including any
code and software unless expressly authorized by Avaya.
Unauthorized reproduction, transmission, dissemination, storage,
and or use without the express written consent of Avaya can be a
criminal, as well as a civil offense under the applicable law.
Third Party Components
“Third Party Components” mean certain software programs or
portions thereof included in the Software or Hosted Service may
contain software (including open source software) distributed
under third party agreements (“Third Party Components”), which
contain terms regarding the rights to use certain portions of the
Software (“Third Party Terms”). As required, information regarding
distributed Linux OS source code (for those Products that have
distributed Linux OS source code) and identifying the copyright
holders of the Third Party Components and the Third Party Terms
that apply is available in the Documentation or on Avaya’s website
at: http://support.avaya.com/Copyright or such successor site as
designated by Avaya. You agree to the Third Party Terms for any
such Third Party Components.
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.
Note to Service Provider
The Product or Hosted Service may use Third Party Components
subject to Third Party Terms that do not allow hosting and require
a Service Provider to be independently licensed for such purpose.
It is your responsibility to obtain such licensing.
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 result in substantial additional charges for your
telecommunications services.
Avaya Toll Fraud intervention
If you suspect that you are being victimized by Toll Fraud and you
need technical assistance or support, call Technical Service Center
Toll Fraud Intervention Hotline at +1-800-643-2353 for the United
States and Canada. For additional support telephone numbers, see
the Avaya Support website: http://support.avaya.com or such
successor site as designated by Avaya. Suspected security
vulnerabilities with Avaya products should be reported to Avaya by
sending mail to: securityalerts@avaya.com.
Trademarks
The trademarks, logos and service marks (“Marks”) displayed in
this site, the Documentation, Hosted Service(s), and Product(s)
provided by Avaya are the registered or unregistered Marks of
Avaya, its affiliates, or other third parties. Users are not permitted
Installing Avaya CMS Connectors March 2017 5
to use such Marks without prior written consent from Avaya or
such third party which may own the Mark. Nothing contained in
this site, the Documentation, Hosted Service(s) and Product(s)
should be construed as granting, by implication, estoppel, or
otherwise,
any license or right in and to the Marks without the express
written permission of Avaya or the applicable third party.
Avaya is a registered trademark of Avaya Inc.
All non-Avaya trademarks are the property of their respective
owners. Linux® is the registered trademark of Linus Torvalds in the
U.S. and other countries.
All non-Avaya trademarks are the property of their respective
owners, and “Linux” is a registered trademark of Linus Torvalds.
Downloading Documentation
For the most current versions of Documentation, see the Avaya
Support website: http://support.avaya.com, or such successor site
as designated by Avaya.
Contact Avaya Support
See the Avaya Support website: http://support.avaya.com for
Product or Hosted Service notices and articles, or to report a
problem with your Avaya Product or Hosted Service. For a list of
support telephone numbers and contact addresses, go to the
Avaya Support website: http://support.avaya.com (or such
successor site as designated by Avaya), scroll to the bottom of the
page, and select Contact Avaya Support.
Installing Avaya CMS Connectors March 2017 6
Table of Contents
Chapter 1: Introduction.................................................................................................7
Purpose.....................................................................................................................................................7
License requirements................................................................................................................................7
Chapter 2: Avaya CMS Connectors Installation .........................................................8
Overview ...................................................................................................................................................8
Downloading the CMS Connectors...........................................................................................................8
Installing the CMS Connectors .................................................................................................................9
Installing Avaya CMS Connectors March 2017 7
Chapter 1: Introduction
Purpose
This document provides a general overview of the Avaya CMS Connectors. This document is
intended for users who want to install and configure Avaya CMS Connectors.
License requirements
WebLM is the default licensing method on CMS R18 Linux and later version. Ensure that the
latest WebLM interface is installed at the location /export/home/pserv/weblm. Also, ensure
that the appropriate license files are installed on the WebLM server and verified by the weblm
interface.
Additional information on WebLM can be found on the http://support.avaya.com website.
If you are using the legacy licensing method on older releases of CMS, then you will need to
engage Avaya Professional Services to have the interfaces installed and licensed.
Installing Avaya CMS Connectors March 2017 8
Chapter 2: Avaya CMS Connectors
Installation
Overview
This document describes the software interface packages (connectors) for the Avaya Call
Management System (CMS) that are offered by Avaya Professional Services (APS). These
interface packages provide near real time and historical data feeds from CMS to external Avaya
and third-party applications.
Downloading the CMS Connectors
Registering for PLDS
Before downloading software from the Avaya Product Licensing and Delivery System (PLDS)
website, you must first register your organization on the PLDS website. You need to use the
credentials provided by the Avaya support team to register your organization.
Procedure
1. Go to the Avaya Product Licensing and Delivery System (PLDS) website at
https://plds.avaya.com.
The PLDS website redirects you to the Avaya single sign-on (SSO) webpage.
2. Log in to SSO with your SSO ID and password.
3. On the PLDS registration page, register as:
An Avaya partner: Enter the Partner Link ID. To know your Partner Link ID, send an
email to prmadmin@avaya.com.
A customer: Enter one of the following:
oCompany Sold-To
oShip-To number
oLicense authorization code (LAC)
4. Click Submit.
Avaya sends the PLDS access confirmation within one business day.
Downloading the software from PLDS
For downloading the installer of the CMS Connector application, you need to visit the Avaya
PLDS website.
Installing Avaya CMS Connectors March 2017 9
Procedure
1. Go to the Avaya Product Licensing and Delivery System (PLDS) website at
https://plds.avaya.com.
The PLDS website redirects you to the Avaya single sign-on (SSO) webpage.
2. Log in to SSO with your SSO ID and password.
3. On the Home page, select Assets:
4. Select View Downloads.
5. Search for the available downloads by using one of the following:
The application type “APS CMS Connectors”
Download name “%ACMS%”
6. Click the download icon from the appropriate download.
7. When the system displays the confirmation box, select Click to download your file
now.
8. If you receive an error message, click the message, install Active X, and continue with
the download.
9. When the system displays the security warning, click Install.
When the installation is complete, PLDS displays the download again with a check mark
next to downloads that have completed successfully.
Installing the CMS Connectors
Before you begin
Ensure that the WebLM interface is installed with the appropriate license files. To view
the list of license file names, run the following command:
cd /export/home/pserv/weblm
./menu
Select the Show Status option to verify the WebLM licenses are validating correctly.
Procedure
1. Unzip the software to a local directory on your local PC or download server
2. Specific installation instructions are included in the zip file. For example, if you are
installing rt_socket, the zip file will be named similar to:
rt_socket_4.4.6.zip
Installing Avaya CMS Connectors March 2017 10
The zip file will contain the software that needs to be copied to the CMS server, the
release notes, and the installation instructions.
rt_socket_4.4.6.bz2
RelNotes.txt
Installation.txt
3. Copy the software (always a file name ending in .bz2) to the customer's CMS (use /tmp
as the destination directory) using one of the following options:
Business Partner: The customer will have to provide the remote access.
VPN or SFTP is commonly used to transfer the package file and license file.
Avaya Employee: SAL can usually be used to transfer the files to the
customer's CMS.
4. Log into the customer’s CMS system using a terminal emulator that supports SSH.
PuTTY (http://www.putty.org) is commonly used.
5. Open the local Installation.txt file with an editor that supports UNIX end of line characters
(WordPad, VIM, Notepad++, etc.) and follow the instructions.
Table of contents
