Avaya Notification Solution Release 2.0 Notification Solution Installation and Administration Guide

Avaya Notification Solution
Installation and Administration
guide
Release 2.0
July 2012
AVAYA GLOBAL SOFTWARE LICENSE TERMS 2012
THIS END USER LICENSE AGREEMENT ("SOFTWARE LICENSE TERMS")
GOVERNS THE USE OF AVAYA'S PROPRIETARY SOFTWARE AND
THIRD-PARTY PROPRIETARY SOFTWARE. READ THESE SOFTWARE
LICENSE TERMS CAREFULLY, IN THEIR ENTIRETY, BEFORE INSTALLING,
DOWNLOADING OR USING THE AVAYA SOFTWARE (AS DEFINED
BELOW). BY INSTALLING, DOWNLOADING OR USING THE AVAYA
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"). IF YOU ARE ACCEPTING THESE TERMS ON BEHALF OF A
COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT YOU
HAVE THE AUTHORITY TO BIND SUCH ENTITY TO THESE SOFTWARE
LICENSE TERMS. ANY USE OF THE SOFTWARE WILL CONSTITUTE
YOUR ASSENT TO THESE SOFTWARE LICENSE TERMS (OR
RATIFICATION OF PREVIOUS CONSENT). IF YOU DO NOT HAVE SUCH
AUTHORITY OR DO NOT WISH TO BE BOUND BY THESE SOFTWARE
LICENSE TERMS, YOU MUST RETURN OR DELETE THE SOFTWARE
WITHIN TEN (10) DAYS OF DELIVERY FOR A REFUND OF THE FEE, IF
ANY, YOU PAID FOR THE LICENSE OR IF SOFTWARE IS ACCESSED
ELECTRONICALLY, SELECT THE "DECLINE" BUTTON AT THE END OF
THESE SOFTWARE LICENSE TERMS.
A. Scope. These Software License Terms are applicable to anyone who
downloads and/or installs Avaya Software and Documentation, purchased from
Avaya Inc., any Avaya Affiliate, or an authorized Avaya reseller (as applicable)
under a commercial agreement with Avaya or an authorized Avaya reseller
("Agreement"). 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 authorized reseller, and Avaya reserves the right
to take legal action against you and anyone else using or selling the Software
without a license. To the extent there is a conflict between these Software
License Terms and another Agreement, the order of precedence shall be (i)
your Agreement with Avaya if you purchased from Avaya Inc. or an Avaya
Affiliate, or (ii) these Software License Terms if you purchased from an
authorized Avaya reseller, except with respect to third party elements subject to
a Shrinkwrap License or other Third Party Terms, in which case the Shrinkwrap
License or other Third Party Terms will prevail. "Affiliate" means any entity that
is directly or indirectly controlling, controlled by, or under common control with
Avaya Inc. or End User. For purposes of this definition, "control" means the
power to direct the management and policies of such party, directly or
indirectly, whether through ownership of voting securities, by contract or
otherwise; and the terms "controlling" and "controlled" have meanings
correlative to the foregoing.
B. License Grant. Avaya grants you a personal, non-sublicensable,
non-exclusive, non-transferable license to use Software and Documentation
obtained from Avaya or an Avaya authorized reseller and for which applicable
fees have been paid for your internal business purposes at the indicated
capacity and features and within the scope of the applicable license types
described below and at locations where the Software is initially installed.
"Documentation" means information published by Avaya in varying mediums
which may include product information, operating instructions and performance
specifications that Avaya generally makes available to users of its products.
Documentation does not include marketing materials. Software installed on
mobile-devices, such as a laptop or mobile phone, may be used outside of the
country where the software was originally installed, provided that such use is
on a temporary basis only.
(i) Right to Move License Entitlements. Notwithstanding the foregoing, You
may move right to use license entitlements (RTU's) from one location to
another in accordance with Avaya's then-current software license move policy
for that Software ("License Portability Policy") which is available upon request
subject to the following conditions:
(a) You shall provide written notice within ten (10) days to Avaya of any
RTU moves including but not limited to, the number and type of licenses
moved, the location of the original Server and the location of the new Server,
the date of such RTU moves and any other information that Avaya may
reasonably request;
(b) You may only move RTU's to and from Designated Processors or
Servers supporting the same Software application;
(c) You must reduce the quantity of the licenses on the original Server by
the number of RTU's being moved to the new Server.
(d) You acknowledge that (1) you may be charged additional fees when
moving RTU's as per Avaya's then-current License Portability Policy, (2)
maintenance services do not cover system errors caused by moves not
performed by Avaya, (3) you are responsible for any programming,
administration, design assurance, translation or other activity to make sure the
Software will scale and perform as specified as a result of any license moves,
and if any such transfer results in a requirement for Avaya system engineering
or requires the use of on-site Avaya personnel, you will be charged the Time &
Materials fees for such activity;
(e) If your maintenance coverage differs on licenses on the same product
instance at the location of the new Server, Service updates, recasts and/or fees
may apply and any fee adjustments for differences in coverage will only be
made on a going forward basis as of the date Avaya receives notice of the RTU
move; and
(f) You may move RTU's from one Affiliate to another Affiliate provided
that you comply with all of the conditions of this section, including, without
limitation, providing the name and address of the new Affiliate in your written
notice under subpart (a) above, and such new Affiliate shall be bound by these
Software License Terms.
(ii) Non-Production License Grant. With respect to Software distributed by
Avaya to you for non-production purposes, Avaya grants to you, subject to the
terms and conditions contained herein, a personal, nonexclusive,
nontransferable and non-sublicensable right to use the Software in a
nonproduction environment solely for testing, development or other
non-commercial purposes on a single computer ("Non-Production License").
C. All Rights Reserved. Except for the limited license rights expressly granted
in these Software License Terms, Avaya reserves all rights in and to the
Software and Documentation and any modifications or copies thereto.
D. General License Restrictions. To the extent permissible under applicable
law, you agree not to: (i) decompile, disassemble, or reverse engineer the
Software; (ii) alter, modify or create any derivative works based on the Software
or Documentation; (iii) use, copy, sell, sublicense, lease, rent, loan, assign,
convey or otherwise transfer the Software or Documentation except as
expressly authorized by the Agreement with a Avaya; (iv) distribute, disclose or
allow use of the Software or Documentation, in any format, through any
timesharing service, service bureau, network or by any other means; (v) allow
any service provider or other third party, with the exception of Avaya's
authorized resellers and their designated employees ("Authorized Providers")
who are acting solely on behalf of and for the benefit of End User, to use or
execute any software commands that cause the Software to perform functions
that facilitate the maintenance or repair of any product except that a service
provider or other third party may execute those software commands that, as
designed by Avaya, would operate if a user is logged into a product using a
customer level login and Maintenance Software Permissions ("MSPs") were
not enabled or activated; (vi) gain access to or the use of any Software or part
thereof without authorization from Avaya; (vii) enable or activate, or cause,
permit or allow others to enable or activate any logins reserved for use by
Avaya or Authorized Providers; or (viii) permit or encourage any third party to
do so. You shall provide Authorized Providers the terms and provisions of this
Agreement and shall obligate Authorized Providers to comply with such terms
and provisions. End User shall be responsible for any third party's failure to
comply and shall indemnify Avaya for any damages, loss, expenses or costs,
including attorneys' fees and costs of suit, incurred by Avaya as a result of
non-compliance with this section. Notwithstanding the foregoing, if the
Software is rightfully located in a member state of the European Union and End
User needs information about the Software in order to achieve interoperability
of an independently created software program with the Software, End User will
first request such information from Avaya. Avaya may charge End User a
reasonable fee for the provision of such information. If Avaya refuses to make
such information available, then End User may take steps, such as reverse
assembly or reverse compilation, to the extent necessary solely in order to
achieve interoperability of the Software with an independently created software
program. To the extent that the End User is expressly permitted by applicable
mandatory law to undertake any of the activities listed in this section End User
will not exercise those rights until End User has given Avaya twenty (20) days
written notice of its intent to exercise any such rights.
E. Backup Copies. End User may create a reasonable number of archival and
backup copies of the Software and the Documentation, provided all proprietary
rights notices, names and logos of Avaya and its suppliers are duplicated on
each copy.
F. Warranty. Avaya provides a limited warranty on its Software. Avaya's
standard warranty language as well as information regarding support while
under
warranty,
is
available
through
the
following
website:
http://support.avaya.com. Please note that if you are acquiring the Software
from an authorized Avaya reseller outside of the United States and Canada, the
warranty is provided to you by said Avaya reseller and not by Avaya. EXCEPT
AS REFERENCED HEREIN, THE SOFTWARE IS PROVIDED "AS IS" AND
NEITHER AVAYA NOR ITS SUPPLIERS MAKES ANY EXPRESS
REPRESENTATIONS OR WARRANTIES WITH REGARD TO ANY
PRODUCTS OR SERVICES OR OTHERWISE RELATED TO THE
AGREEMENT OR SOFTWARE LICENSE TERMS. AVAYA DOES NOT
WARRANT UNINTERRUPTED OR ERROR FREE OPERATION OF
PRODUCTS. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE
LAW, AVAYA DISCLAIMS ALL WARRANTIES IMPLIED OR STATUTORY,
INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NON-INFRINGEMENT.
G. Compliance. Avaya will have the right to inspect End User's compliance
with these Software License Terms.
H. Termination of License. If you breach the license limitations or restrictions
in these Software License Terms and if within ten (10) business days of your
receipt of a reasonably detailed written request to cure, you have not cured all
breaches of license limitations or restrictions, Avaya may, with immediate
effect, terminate the Software licenses granted in these Software License
Terms without prejudice to any available rights and remedies. Upon termination
or expiration of the license for any reason, you shall immediately return the
Software and any copies to Avaya, or, at Avaya's discretion and written notice
to you, you shall permanently destroy all copies of the Software and any
related materials in your possession or control. Inadvertent copies of the
Software and any related materials remaining in the possession of the End
User subsequent to termination or expiration shall not be implied or construed
as Avaya consenting to transfer ownership of the Software and any related
materials to the End User. The provisions concerning confidentiality, indemnity,
license restrictions, export control, and all limitations of liability and disclaimers
and restrictions of warranty (as well as any other terms which, by their nature,
are intended to survive termination) will survive any termination or expiration of
the Software License Terms.
I. License Types. Avaya grants you a license within the scope of the license
types described 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. "Software" means the computer programs in
object code, originally provided by Avaya and ultimately utilized by you,
whether as stand-alone products or pre-installed on hardware products,
originally sold by Avaya and ultimately utilized by you.
Designated System(s) License (DS). End User may install and use each
copy 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, 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.
Database License (DL). End User may install and use each copy 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 a
single instance of the same database.
CPU License (CP). End User may install and use each copy 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").
J. Third-party Components. Certain software programs or portions thereof
included in the Software may contain software (including open source
software) distributed under third party agreements ("Third Party Components"),
which may contain terms that expand or limit rights to use certain portions of
the Software ("Third Party Terms"). Information 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.
K. Limitation of Liability. EXCEPT FOR PERSONAL INJURY CLAIMS,
WILLFUL MISCONDUCT AND END USER'S VIOLATION OF AVAYA'S OR ITS
SUPPLIERS INTELLECTUAL PROPERTY RIGHTS, INCLUDING THROUGH
A BREACH OF THE SOFTWARE LICENSE TERMS AND TO THE EXTENT
PERMITTED UNDER APPLICABLE LAW, NEITHER AVAYA OR ITS
SUPPLIERS NOR END USER SHALL BE LIABLE FOR (i) ANY INCIDENTAL,
SPECIAL, STATUTORY, INDIRECT OR CONSEQUENTIAL DAMAGES, OR
(ii) FOR ANY LOSS OF PROFITS, REVENUE, OR DATA, TOLL FRAUD, OR
COST OF COVER AND (iii) DIRECT DAMAGES ARISING UNDER THESE
SOFTWARE LICENSE TERMS IN EXCESS OF THE PURCHASE PRICE
AND FEES PAID FOR THE PRODUCTS OR SERVICES GIVING RISE TO
THE CLAIM.
L. Protection of Confidential Software and Documentation. End User
acknowledges that the Software and Documentation are regarded as
confidential information by Avaya and its suppliers, ("Confidential Information")
and End User agrees at all times to protect and preserve in strict confidence
the Software and Documentation.
M. Protection of Personal Data. The use of the Software may require the
processing of personal data pertaining to you or to your personnel. Personal
data required to use the Software will need to be submitted to Avaya. Failing
the submission of such data, the use of the Software will not be possible. You
or your personnel have a right to access and correct erroneous personal data
pertaining to you or your personnel and to object for legitimate reasons to the
processing and transfer of these data. You can exercise this right by contacting
in writing the Data Privacy Officer of the applicable Avaya Affiliate.
N. High Risk Activities. The Software is not fault-tolerant and is not designed,
manufactured or intended for any use in any environment that requires fail-safe
performance in which the failure of the Software could lead to death, personal
injury or significant property damage ("High Risk Activities"). Such
environments include, among others, control systems in a nuclear, chemical,
biological or other hazardous facility, aircraft navigation and communications,
air traffic control, and life support systems in a healthcare facility. End User
assumes the risks for its use of the Software in any such High Risk Activities.
O. Export Control. End User is advised that the Software is of U.S. origin and
subject to the U.S. Export Administration Regulations (EAR). The Software
also may be subject to applicable local laws and regulations. Diversion
contrary to U.S. and applicable local country law and regulation is prohibited.
You agree not to directly or indirectly export, re-export, import, download, or
transmit the Software to any country, end user or for any use that is prohibited
by applicable U.S. and local country regulation or statute (including but not
limited to those countries embargoed by the U.S. government). You represent
that neither the U.S. Bureau of Industry and Security (BIS) nor any other
governmental agency has issued sanctions against End User or otherwise
suspended, revoked or denied End User's export privileges. You agree not to
use or transfer the Software for any use relating to nuclear, chemical or
biological weapons, or missile technology, unless authorized by the U.S. and
applicable local government by regulation or specific written license.
Additionally, you are advised that the Software may contain encryption
algorithm or source code that may be limited for export to government or
military end users without a license issued by the U.S. BIS and any other
country's governmental agencies, where applicable. Lastly, you agree not to
directly or indirectly export, reexport, import, or transmit the Software contrary
to the laws or regulations of any other governmental entity that has jurisdiction
over such export, import, transmission, or use.
P. U.S Government End Users. The Software is classified as "commercial
computer software" and the Documentation is classified as "commercial
computer software documentation" or "commercial items," pursuant to FAR
12.212 or DFAR 227.7202, as applicable. Any use, modification, reproduction,
release, performance, display or disclosure of the Software or Documentation
by the Government of the United States shall be governed solely by the terms
of these Software License Terms and shall be prohibited except to the extent
expressly permitted by the terms of these Software License Terms.
Q. Acknowledgement. End User acknowledges that certain Software may
contain programming that: (i) restricts, limits and/or disables access to certain
features, functionality or capacity of such Software subject to the End User
making payment for licenses to such features, functionality or capacity; or (ii)
periodically deletes or archives data generated by use of the Software and
stored on the applicable storage device if not backed up on an alternative
storage medium after a certain period of time.
R. Miscellaneous. These Software License Terms will be governed by New
York State laws, excluding conflict of law principles and the United Nations
Convention on Contracts for the International Sale of Goods. If a dispute
cannot be settled by good faith negotiation between the parties within a
reasonable period of time, and to the extent authorized by applicable law, it
must be finally settled upon request of either party by arbitration to be held in
accordance with the Rules of Arbitration of the International Chamber of
Commerce by a single arbitrator appointed by the parties or (failing agreement)
by an arbitrator appointed by the President of the International Chamber of
Commerce (from time to time). The arbitration will be conducted in the English
language, at a location agreed by the parties or (failing agreement) ordered by
the arbitrator. The arbitrator will have authority only to award compensatory
damages and will not award punitive or exemplary damages. The arbitrator will
not have the authority to limit, expand or otherwise modify the Software
License Terms. The ruling by the arbitrator will be final and binding on the
parties and may be entered in any court having jurisdiction. Avaya and you will
each bear its own attorneys' fees associated with the arbitration.
Notwithstanding the foregoing, Avaya shall be entitled to take immediate legal
action where required to protect its confidential or proprietary information, or to
obtain any interim injunction. If any provision of these Software License Terms
is determined to be unenforceable or invalid, these Software License Terms will
not be rendered unenforceable or invalid as a whole, and the provision will be
changed and interpreted so as to best accomplish the objectives of the original
provision within the limits of applicable law. The failure to assert any rights
under the Software License Terms, including, but not limited to, the right to
terminate in the event of breach or default, will not be deemed to constitute a
waiver of the right to enforce each and every provision of the Software License
Terms in accordance with their terms. If you move any Software, and as a
result of such move, a jurisdiction imposes a duty, tax, levy or fee (including
withholding taxes, fees, customs or other duties for the import and export of
any such Software), then you are solely liable for, and agree to pay, any such
duty, taxes, levy or other fees.
S. Agreement in English. The parties confirm that it is their wish that these
Software License Terms, as well as all other documents relating hereto,
including all notices, have been and shall be drawn up in the English language
only. Les parties aux présentes confirment leur volonté que cette convention,
de même que tous les documents, y compris tout avis, qui s'y rattachent, soient
rédigés en langue anglaise. Las partes ratifican que es su voluntad que este
Contrato, así como cualquier otro documento relacionado con el mismo,
incluyendo todo tipo de notificaciones, han sido redactados y deberán
continuar siendo redactados únicamente en el idioma inglés.
Table of contents
Table of contents
Chapter 1: Introduction to ANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Other documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Business values and use cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Basic features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
ANS architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ANS components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 2: Site-preparation worksheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Preinstallation requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Customer site requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 3: ANS implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Verifying the IP address of the host server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Copying the ANS 2.0 installer file to the ANS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing Loquendo TTS 7.8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Applying the Loquendo license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing Avaya Media Server 7.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Avaya Media Server 7.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing the ANS binary file all-in-one server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing the ANS binary file in the high-availability servers . . . . . . . . . . . . . . . . . . . . . . .
Applying the ANS license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
30
30
30
30
32
32
33
34
35
Upgrading to ANS 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading the all-in-1 server from R1.2 to R2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upgrading the HA servers from R1.2 to R2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Re-installing ANS 2.0 in the same servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Re-installing the all-in-one server: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Re-installing the HA servers: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
36
37
39
43
43
44
Uninstalling ANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Chapter 4: Quick configuration of ANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Logging in to the ANS Management Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
(Optional) Resetting the admin password to default value . . . . . . . . . . . . . . . . . . . . . . . . .
Add the Permitted and Trusted IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring email channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the TTW servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation and Administration guide
July 2012
49
49
50
50
50
5
Configuring SIP Trunks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring media server resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the SMS channel with Clickatell Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the ANS SMS Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring IP Phones to work with the ANS IP Phone Channel . . . . . . . . . . . . . . . . . . . .
Configuring the Meeting Exchange to work with ANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
51
52
53
53
54
55
Chapter 5: Quick testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Quick testing of ANS configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Chapter 6: Administering the ANS system configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Adding a From Address and Display Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Configuring voice channel resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the TTW servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the TTS Locales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Resource Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring media server resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring SIP trunk resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to CS1000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to Session Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to SES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to IP Office. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to Audiocodes SIP gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to Session Border Controller. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting ANS to Meeting Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
60
60
61
61
61
62
62
63
64
65
65
66
67
68
Channel configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the channel settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting E-mail channel to SMTP relay server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Avaya 96xx and 46xx IP phones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the Avaya 11xx and 12xx IP phones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the ANS SMS channel for Clickatell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the ANS SMS channel for SMPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the ANS SMS channel for GSM modem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sending SMS through e-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the IBM Sametime server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring XMPP to connect to the Presence Server . . . . . . . . . . . . . . . . . . . . . . . . . . . .
69
69
70
70
71
72
73
74
75
75
77
Configuring Web services API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Trigger configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Adding an inbound phone number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
6
Installation and Administration guide
Comments? [email protected]
July 2012
Adding an e-mail trigger mailbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Configuring message inboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Chapter 7: Administering the ANS user configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying partition details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deleting a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
83
83
83
84
Configuring LDAP settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
User management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
User management overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Importing users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing users using a CSV file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing users using the LDAP mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Authoring role to a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
87
88
90
User profile settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding a user defined field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Modifying the user defined field details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deleting a user defined field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adding user password settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring a notification rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring file size for attachments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
91
91
92
92
92
93
95
Chapter 8: Maintaining ANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Backing up the ANS database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Restoring the ANS database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Restoring the database in an all-in-one server: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Restoring the database and recovering the database sync in HA servers: . . . . . . . . . . . . 98
Scheduling backup and archive of the ANS database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Maintaining/Viewing the driver channel status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Maintaining the registered IP Phones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Deleting a registered IP Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Maintaining Resource Manager status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maintaining resource status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maintaining resource assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maintaining resource manager registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
102
103
104
104
ANS Recovery Manager and Watchdog service overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Recovery Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Downloading the ANS logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Installation and Administration guide
July 2012
7
Restarting the ANS services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Running the SIP call trace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Chapter 9: Quick troubleshooting tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Appendix A: Port specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Appendix B: System specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Appendix C: ANS Service Scripts Mapping Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Appendix D: Enabling port 80 and port 443 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Appendix E: Updating the certificate for the Web portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Appendix F: Clickatell status codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Appendix G: SNMP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Appendix H: Configuring Audio Codec and RTP ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Appendix I: Configuring the system voice prompts with or without Loquendo Text To Speech 127
8
Installation and Administration guide
Comments? [email protected]
July 2012
Overview
Chapter 1: Introduction to ANS
Overview
Avaya Notification Solution (ANS) is a centrally located message broadcast and notification
system. ANS is designed for midsize to large organizations that are typically in the public sector,
education, energy, and health care markets. Midsize and large organizations need an
emergency notification system that works with their communications infrastructure, dial plans,
and supporting systems. ANS uses SIP standards architecture and Web services API to
integrate and utilize the Avaya next generation communications infrastructure and assets. This
integration insulates businesses from the migration to a converged voice and data IP based
backbone and at the same time provides superior capabilities, services, and integration with
exceptional partner solutions at a reduced cost across a spectrum of communications mediums.
You can also use ANS in the following scenarios:
●
In the event of an emergency, pending crisis, or business urgent scenario, you can use
ANS to instantly reach to key stakeholders and decision-makers regardless of means of
communications.
●
When using private branch exchange (PBX), wireless, residential, Voice over Internet
Protocol (VoIP), Short Message Service (SMS) or e-mail, you can use ANS to deliver
instructions on what to do, how to proceed, and has the ability to solicit real-time response.
Therefore, organizations act effectively, reducing risk and saving lives.
The Installing and administering ANS guide describes the procedure to install ANS, administer
ANS using the ANS Management Portal, and configure the ANS system settings.
Intended audience
This document is intended for personnel who use ANS, such as:
●
Trained field installation and maintenance personnel
●
Technical support personnel
●
Authorized business partners
●
ANS administrators
ANS Installation and Administration guide
July 2012
9
Chapter 1: Introduction to ANS
Other documentation
For ANS technical and end-user documents, see, the Avaya Support Web site at http://
www.avaya.com/support.
Business values and use cases
Most organizations have business continuity or disaster recovery plans for recovery from
natural or man-made disasters. Many organizations have plan to deal with business critical
events if and when they occur. Not all the organizations are equipped with the right
communications tools to respond effectively during such events. As events unfold,
organizations provide information on what is taking place, solicit an acknowledgement or
response, or support real-time collaboration through audio and media conferencing services. A
highly mobile society with decentralized workplaces complicates matters. An e-mail, calendar
invite, or voice mail message at the last minute, or after the fact is no longer enough. Instead,
organizations today need to be proactive. The organizations need the communications tools to
enable automated real-time notification, response, and collaboration. The organizations need
the ability to reach individuals at the push of a button.
You can use ANS to transmit critical information and instructions in a real-time scenario across
your organization or response network. By pressing a button, you can issue a pre-scripted or
recorded message to a targeted group of recipients. You can then gather a response or place
the recipients into a conference bridge. ANS is highly flexible and powerful and is designed to
address the needs of small to mid-size organizations. ANS can also address the needs of large
enterprises. ANS supports community-based notification applications seen with government
agencies, businesses, educational, health care institutions, and critical infrastructure such as
airports, seaports, oil refineries, and related facilities. ANS provides management team, security
personnel, first-line response teams, and public safety workers a centralized way to alert
people, gather feedback, and place key stakeholders in to a collaborative environment.
ANS can be applied to the following use cases:
●
Federal and Local Government
- Regional Notification Services, such as weather, transportation, natural disaster – fire,
hurricane, tornado, snow, and so on.
- Emergency Operations Center (EOC)
- Facilities, base or campus, physical security and logistics
- Crash management, recovery and response (Transportation)
- IT services Management and help desk
10
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Basic features
●
Education - higher education, K-12
- Personal and physical security
- Parental or guardian notification
- Local community
- Surveillance, threat response, and out of service
●
Energy, utilities, and infrastructure
- Critical event
- Incident response
- Operations and production
●
Enterprise or campus environment
- Business continuity and disaster recovery
- Personal and physical security
- IT services Management and help desk
●
Health care industry
- IT services Management and help desk
- Incident response
Basic features
ANS offers the following basic features:
●
Multiple channels including voice, e-mail, SMS, Instant Messaging (IM), and IP Phone
broadcast.
●
Configure multiple questions and choices in two-way channels.
●
Notify and transfer.
●
Notify and conference.
●
Built-in media server for ad hoc conferencing.
●
Pre-recorded .wav file and text to speech.
●
Auto answer detection and leave messages in voice mail.
●
Inbound call for the message retrieval and response.
ANS Installation and Administration guide
July 2012
11
Chapter 1: Introduction to ANS
●
Manage notification scenarios on the ANS Management Portal.
●
Detailed notification reports.
●
Triggering notification through the ANS Management Portal, inbound calls, and inbound
e-mail.
●
Message security through recipient Personal Identification Number (PIN).
●
Escalation tree.
●
User and group management.
●
Lightweight Directory Access Protocol (LDAP) synchronization.
●
User profile Comma Separated Values (CSV) upload.
●
Tenant partition.
●
Standard Web services interface for external integrations.
ANS architecture
ANS architecture has the three layers as illustrated in the following diagram:
The following figure describes the connectivity between ANS and its various components:
12
ANS Installation and Administration guide
Comments? [email protected]
July 2012
ANS architecture
ANS components
ANS consists of the following components:
●
Management Portal
●
Coordinator
●
Channel drivers
●
Media Server
●
Text to Wave (TTW)
●
Resource Manager
●
Recovery Manager
●
PostgreSQL database
●
LDAP synchronization module
●
Database synchronization
●
File synchronization
ANS Installation and Administration guide
July 2012
13
Chapter 1: Introduction to ANS
14
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Chapter 2: Site-preparation worksheet
Preinstallation requirements
Items
Requirements/Minimum
configurations
Notes
Loquendo License P.I.K.
One P.I.K for the all-in-one server
setup and two P.I.K.s for the High
Availability setup.
ANS License .xml file.
You can generate the ANS License
file on the Avaya PLDS Web site with
both server MAC addresses.
License
Server
One server for the all-in-one server setup, two servers for the High Availability setup.
If multiple NICs are active, make sure that they are bonded together. But if you require
to use a separated NIC for a separated management LAN connection and cannot
bond the NIC with eth0, you must disable those NICs (except eth0 or bond0 which
should be connected to the telcom LAN) during the installation, and then re-activate
them after the installation is completed.
Server with RHEL 5.4, 5.5,
5.6, or 5.7; not 6.x.
Use the following Linux command to
check the RHEL version:
cat /etc/redhat-release
Server has 32-bit RHEL;
not 64-bit.
Use the following Linux command to
verify:
uname -a
Server has at least 8GB
RAM for production
(12GB RAM is
recommended for the
high performance and
high capacity system).
Use the following Linux command to
verify:
free -m
ANS Installation and Administration guide
July 2012
15
Chapter 2: Site-preparation worksheet
Items
16
Requirements/Minimum
configurations
Notes
Server has 8 cores for
production (at least 4
cores for lab demo).
Use the following Linux command to
verify:
cat /proc/cpuinfo
Server hosts file 27.0.0.1
corresponds to localhost.
Use the following Linux command to
verify:
cat /etc/hosts
Server hostname has
up-to 16 characters
with no special
characters, and only
alphanumeric characters.
The following commands
should display the same results:
hostname
uname -n
SE Linux is disabled.
Use the following Linux command to
verify:
vi /etc/selinux/config
- set SELINUX=disabled
- then restart the server.
Server Linux firewall is
disabled.
Use the following Linux commands to
verify:
service iptables stop
chkconfig iptables off
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Items
Requirements/Minimum
configurations
Notes
Server NTP is configured.
Use the following Linux commands to
verify:
vi /etc/ntp.conf
- Remove the following:
a. server 0.rhel.pool.ntp.org
b. server 1.rhel.pool.ntp.org
c. server 2.rhel.pool.ntp.org
- Add the following at the end of the
file:
Note: Replace ntp.dr.avaya.com
with the customer's ntp server
name.
a. server ntp.dr.avaya.com
b. restrict ntp.dr.avaya.com mask
255.255.255.255 nomodify notrap
noquery
chkconfig ntpd on
service ntpd start
ntpdate -u ntp.dr.avaya.com
ntpq -p
Note: Replace ntp.dr.avaya.com
with the customer's ntp server
name.
Server has DNS IP
addresses configured.
Remove PostgreSQL and
Apache Web Server (if
they exist).
Server root access or a
user in the root group for
installing ANS.
If IP phone broadcast
channel is required, make
sure that there is a local
DISPLAY on :0 to :15.
If there is no local display
on those ports, you can
enable the VNC on the
server which will add a
display.
ANS Installation and Administration guide
July 2012
17
Chapter 2: Site-preparation worksheet
Items
Requirements/Minimum
configurations
Notes
If the Voice LAN and Data
LAN are separately
connected to different NIC
of the server, make sure to
connect the Voice LAN to
the eth0.
18
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Items
Requirements/Minimum
configurations
Notes
(Optional) Set up VNC for
remote access:
Note: VNC is required to
support the IP phone
broadcast channel and
configure the database
auto backup and archive
remotely.
a. Set the vncserver configuration:
vi /etc/sysconfig/
vncservers
Uncomment the last two lines and
change to:
VNCSERVERS="0:root"
VNCSERVERARGS[0]="-geometry
800x600 -nolisten tcp
-nohttpd -localhost"
b. Restart the vnc services:
service vncserver restart
c. Set the vnc login password:
vncpasswd
d. Start the VNC so that it can create
the startup file: vncserver
e. Set the VNC startup
configurations:
vi /root/.vnc/xstartup
Uncomment the following two lines
for normal desktop:
unset SESSION_MANAGER
exec /etc/X11/xinit/xinitrc
f. Stop the VNC service on the first
port:
vncserver -kill :1
g. Restart the VNC service with the
new settings:
service vncserver restart
h. Set the VNC service to auto
startup after server reboot:
chkconfig vncserver on
chkconfig --list vncserver
ANS Installation and Administration guide
July 2012
19
Chapter 2: Site-preparation worksheet
Items
Requirements/Minimum
configurations
Notes
Voice Channel only
SIP trunks are configured
in the IP-PBX or gateways
for connecting to ANS
servers.
Note: ANS R2.0
supports only TCP and
UDP type of SIP trunks.
ANS R2.0 does not
support TLS type of SIP
trunks.
Email Channel only
SMTP relay server.
SMS Channel only
Clickatell account
information for using the
Clickatell services.
ANS server can access
through public Internet to
https://api.clickatell.com
20
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Items
Requirements/Minimum
configurations
Notes
IP Phone Broadcast only
Latest firmware from the
support.avaya.com for
Avaya 96xx, 96x1, or 46xx
IP phones.
Access to 46xxsettings.txt
file on the TFTP or HTTP
server.
Note: Set the IP phone
RTP range away from
5006 to 6002, if possible,
to avoid potential port
conflicts during IP phone
audio broadcast. ANS is
using some UDP ports in
this range. The RTP
range settings for the
96xx SIP phones are in
the 46xxsettings.txt file.
The RTP range settings
for the 96xx H.323
phones are in the CM
network region
configurations.
ANS Installation and Administration guide
July 2012
21
Chapter 2: Site-preparation worksheet
Items
Requirements/Minimum
configurations
Notes
Unistim 5.2 or later from
the support.avaya.com for
Avaya 11xx, 12xx, or 2007
IP phones.
Access to DHCP server
for creating the option 66
for the TFTP or HTTP
server address for IP
phone auto provisioning
with system.prv file.
A local display or VNC
should be configured to
support the audio
broadcast to IP phones.
LDAP synchronization only
Have the LDAP server
information.
Also must know the
mapping between ANS
user profile fields and
LDAP attributes.
Firewall ports
All required firewall ports
must be open, if any
firewall exists between
ANS and connecting
servers or devices.
22
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Customer site requirements
Items
Requirements/Minimum
configurations
Notes
Servers and Operating Systems
For supporting up-to 600 voice ports or up-to a total of 25,000 user addresses for each
notification session.
All-in-one server
setup
Requires only one server.
Minimum: 8 cores with Intel
or AMD 2.8 GHz CPU, 8 GB
of RAM, 120 GB.
Recommended for high
performance: 8 cores with
Intel or AMD 2.8 GHz CPU,
12 GB of RAM, 120 GB.
32-bit Red Hat Enterprise
Linux version 5.4, 5.5, 5.6, or
5.7.
High Availability setup
The OS must be pre-installed
by the customer. Each ANS
server requires one physical
IP address.
Requires two servers with the
same configuration.
Minimum: 8 cores with Intel
or AMD 2.8 GHz CPU, 8 GB
of RAM, 120 GB.
Recommended for high
performance: 8 cores with
Intel or AMD 2.8 GHz CPU,
12 GB of RAM, 120 GB.
32-bit Red Hat Enterprise
Linux version 5.4, 5.5, 5.6, or
5.7.
ANS Installation and Administration guide
The OS must be pre-installed
by the customer. Each ANS
server requires one physical
IP address. Customers must
also provide one virtual IP
address that will be shared by
the two ANS servers.
July 2012
23
Chapter 2: Site-preparation worksheet
Items
Requirements/Minimum
configurations
Notes
VMware vSphere
ESX 4.0 Virtual
Machine (VM)
Minimum: Dedicated 8 cores
with 2.8 GHz CPU, 8GB of
RAM, 120 GB storage,
Dedicated NIC.
Recommended for high
performance: Dedicated 8
cores with 2.8 GHz CPU,
12GB of RAM, 120 GB
storage, Dedicated NIC.
32-bit Red Hat Enterprise
Linux version 5.4, 5.5, 5.6, or
5.7
Note:
Note:
The Virtual IP Address is required to support the ANS High Availability
(HA) configuration. The two ANS servers in the HA cluster need to be in
the same IP subnet. Customer also needs to assign an unused IP
address from the subnet to be the virtual IP address, which is shared
between two ANS servers based on the Linux Heartbeat. The Linux
Heartbeat is included as part of the ANS software installation.
The server should be dedicated for ANS. To ensure the availability and
performance, and to avoid port conflicts and other potential issues, you
must not install other Avaya or non-Avaya applications or unsupported
utility programs on the same server.
Voice channels
24
Direct SIP trunks to Avaya
Communication Manager 5.x
and later.
Maximum 300 ANS voice
ports for each Communication
Manager system.
SIP trunks through Avaya SIP
Enablement Services to
Communication Manager 4.x
and later.
Maximum 200 ANS voice
ports for each Communication
Manager system or Avaya
SIP Enablement Services
system.
SIP trunks to Nortel CS1000
R5.x and later.
Maximum 300 ANS ports for
each CS1000 system with
dedicated signaling server.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Items
Requirements/Minimum
configurations
Notes
SIP trunks to Avaya Session
Manager (SM).
Maximum 600 ANS ports for
each SM with multiple
Communication Manager or
CS1000 systems.
SIP trunks to IP office or
Avaya Branch Gateway.
Maximum 50 ANS ports for
each IP office or Avaya
Branch Gateway systems.
SIP trunks to Service
Providers through Session
Border Controller (SBC).
Maximum 600 ANS voice
ports for each Service
Provider SIP trunks.
SIP trunks to Avaya Meeting
Exchange R5.2 SP1 or later.
Configure IP-PBX SIP trunks
for connecting to ANS.
This includes caller ID
numbers for outbound
notification calls and phone
numbers for inbound calls to
ANS.
Ensure that IP-PBX has
enough trunks and resources
to support the voice
notification call traffics.
Avaya Meeting Exchange
R5.2 SP1 and later
Configure Meeting Exchange
conference bridge moderator
and participant codes as
Direct DID numbers.
ANS Installation and Administration guide
Then ANS can transfer the
users into the Meeting
Exchange conferences
directly without prompting for
entering the conference
codes.
July 2012
25
Chapter 2: Site-preparation worksheet
Items
Requirements/Minimum
configurations
IP Phone Broadcast
Channel
Notes
Ensure that the IP phones
meet the firmware release
level requirements.
Set the push parameters in
the automatic provisioning
file.
Reboot all the IP phones after
the ANS servers are installed
so that IP phones can be
registered to ANS servers.
Avaya does not
recommended tha you
broadcast the audio through
WAN connections or through
firewalls.
All IP phones might not have
duplicated extensions.
Supported IP
phones:
Avaya 9620, 9630,
9640, 9650, 9670
Avaya 9608, 9611,
9621, 9641
Avaya 9601
26
●
Require firmware R3.1
SP2 or later for the
H.323 mode.
●
Require firmware R2.6
SP5 or later for the SIP
mode.
●
Require firmware R6.2
SP2 or later for the
H.323 mode.
●
Require firmware R6.0
SP2 or later for the SIP
mode.
Require firmware R6.1 SP3 or
later for the SIP mode.
ANS Installation and Administration guide
These types of IP phones
support audio, topline, and
display push.
These types of IP phones
support audio, topline, and
display push.
This type of IP phones
support audio and topline
push, but does not support
display push.
Comments? [email protected]
July 2012
Items
Requirements/Minimum
configurations
Notes
Avaya 4610, 4621,
4625
Recommend firmware R2.9
SP2 or later for the H.323
mode.
The 4621 and 4625 types of
IP phones support audio,
topline, and display push.
The 4610 type of IP phones
support only audio and topline
push, and does not support
display push..
Avaya (Nortel) 1110,
1120E, 1140E, 1150E,
1165E, 1210, 1220,
1230, 2007
Require Unistim 5.2 or later.
1140E, 1150E, 1165E, and
2007 types of IP phones
support audio, topline, and
display push.
1110, 1120E, 1210, 1220,
1230 types of IP phones
support only audio and topline
push, and does not support
display push.
Create an account at
Clickatell Web site:
http://www.clickatell.com.
You can sign up for the small
business US or International
account with the following
volume limits:
After logging into the
Clickatell site, add a
connection for SOAP and
HTTP type under the Manage
my Products menu bar.
For United States local SMS
account, a SMS phone
number needs to be ordered
and associated with the
SOAP API.
SMS Channel
Clickatell account
●
10 message per
second.
●
Max 5000 messages
every 24 hours.
●
Max 10,000 messages
per month.
Otherwise you need to sign
up for the enterprise
account.
Local GSM modems
for low volume 2-way
SMS
Multi-Tech MultiModem
GPRS MTCBA-G-F4 Wireless cellular modem external - RS-232 - GSM,
GPRS.
ANS Installation and Administration guide
July 2012
27
Chapter 2: Site-preparation worksheet
Items
Note:
Requirements/Minimum
configurations
Notes
Note:
ANS supports connections to the Clickatell service provider services for
1-way SMS services. If the customer decides to use Clickatell, the
customer must create an account at Clickatell website and pay for the
costs of SMS messages at Clickatell.
ANS can also support standard SMPP connections to service providers
for 2-way SMS. Additional integration efforts may be required for
integrating with non-certified service providers. The customers must pay
for the service provider charges.
28
Email Channel
Provide SMTP server
information which will be used
by ANS for sending the
outbound notification emails.
Email Trigger
Only supports:
Microsoft Exchange Server
2007 or later.
IM Channel
Provide the XMPP server or
IBM Sametime server for
enabling the IM channel.
LDAP Directory
Synchronization
Provide the LDAP server
connection information and
LDAP attribute mapping for
enabling this feature.
ANS Installation and Administration guide
ANS supports the inbound
email triggers.
ANS supports periodical
one-way synchronization with
the corporate LDAP directory.
The customers can use the
ANS Management Portal to
manually upload the CSV files
into the ANS user profile
database without using LDAP.
Comments? [email protected]
July 2012
Chapter 3: ANS implementation
You can install ANS using the procedures discussed in this section based on your requirement:
●
All in one server installation: All ANS components are installed in the same server.
●
High Availability installation: ANS is installed in two servers.
Implementation of ANS 2.0 involves one of the following phases based on your ANS software
version:
●
If you already have ANS 1.2 in your system:
- Complete the installation prerequisites.
- Back up and uninstall ANS 1.2.
- Copy the ANS 2.0 installer file to the ANS Server and unpackage the installer file.
- Install Avaya Media Server (AMS).
- Configure AMS.
- Install ANS 2.0.
- Apply ANS license.
- Configure ANS.
- Verify the ANS configuration.
Note:
For more information on upgrading from ANS 1.2 and earlier to ANS 2.0, see
Upgrading to ANS 2.0 on page 36.
Note:
●
If you are installing ANS for the first time:
- Complete the installation prerequisites.
- Copy the ANS 2.0 installer file to the ANS Server.
- Install Loquendo and apply a valid Loquendo license.
- Install Avaya Media Server (AMS).
- Configure AMS.
- Install ANS 2.0.
- Apply ANS license.
- Configure ANS.
- Verify the ANS configuration.
ANS Installation and Administration guide
July 2012
29
Chapter 3: ANS implementation
Verifying the IP address of the host server
Run the following command:
●
vi/etc/hosts
This verifies the IP address of the server on which ANS is getting installed.
Copying the ANS 2.0 installer file to the ANS Server
1. Download the ANS installer file and put it onto the ANS server.
The file name should have a name as follows: ans2.0.xxxx.tar.gz.
The xxxx is the ANS load number.
2. Unpackage the installer file from /root by running the following command:
tar -xzvf ans2.0.xxxx.tar.gz
The system creates a folder as follows: /root/ans2.0.xxxx
Installing Loquendo TTS 7.8
1. Run the following commands:
●
cd /root/ans2.0.xxxx/Loquendo TTS 7.8
●
./loquendo-install.sh
2. Accept all the default file paths.
3. Select 1 for Full Installation, and then select y for auto start with system start-up.
Applying the Loquendo license
Note:
30
Note:
Perform this task before performing the ANS 2.0 installation to save time.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Note:
Note:
If you have not purchased the Loquendo License, you can skip the steps to apply
Loquendo license. But run the following commands after installing the ANS
binary:
To change the file name:
mv /opt/Avaya/SIPAS/8.0.50/ServiceHost0/var/
VoicePromptsPath_en_US.properties.backup /opt/Avaya/SIPAS/
8.0.50/ServiceHost0/var/VoicePromptsPath_en_US.properties
To restart the service:
service ServiceHost0 stop
service ServiceHost0 start
These commands allow the ANS voice channel to use the static wav files as
system prompts, instead of using the text-to-speech services for the system
prompt.
1. Run the following commands:
●
cd /root/ans2.0.nnnn
●
./LoquendoLicenseManager
2. Follow the questions on the screens till you are required to enter the P.I.K. number.
3. Enter the assigned Loquendo P.I.K. number at the prompt.
4. Enter the customer or installer's email address.
The system creates the following file:
/root/ans2.0.nnnn/LoquendoLicenseRequest.txt.
5. Open a Web browser and enter the following URL:
http://network.nuance.com
6. Log on to the Web site and then generate a Loquendo license with the P.I.K and the
LoquendoLicenseRequest.txt file.
7. Download the license file on the ANS server.
The file name is similar to the following:
9E05DEF0CB8B2EE3D8_6.2.0_ANSXie_SUITE_Shell.sh
8. Run the following commands:
●
chmod 755 9E05DEF0CB8B2EE3D8_6.2.0_ANSXie_SUITE_Shell.sh
●
./9E05DEF0CB8B2EE3D8_6.2.0_ANSXie_SUITE_Shell.sh
The system applies the Loquendo license file to the ANS system.
ANS Installation and Administration guide
July 2012
31
Chapter 3: ANS implementation
Installing Avaya Media Server 7.5
1. Run the following commands:
●
cd /root/ans2.0.xxxx/AMS7.5.0.xxx
●
./MediaServer_7.5.0.xxx_date.bin
2. Accept all the default values on the screen questions.
3. (Optional) If the system displays any failed messages on any of the items, check the failed
items in /root/maspviresult.xml file.
Configuring Avaya Media Server 7.5
Note:
Make sure to configure the Avaya Media Server (AMS) before installing ANS 2.0
to avoid port conflicts.
Note:
1. Run the following commands:
●
cd /root/ans2.0.xxxx
●
./configureAMS.sh
2. Open a Web browser and enter the following URL for the AMS Element Manager Web
Portal:
https://xxx.xxx.xxx.xxx:9443
Replace xxx.xxx.xxx.xxx with the ANS server IP address.
3. Login using the root or Linux user that is in the root group.
4. From the Home page, go to Licensing > General Settings. Click Save and then
Confirm.
5. From the Home page, go to System Configuration> Signaling Protocols> SIP> Nodes
and Routes, and then perform the following tasks:
●
Note:
If you are sharing a pair of AMS from multiple ANS servers in the hosted ANS,
make sure that you add all the ANS server IP addresses as trusted nodes in both
AMS servers.
Note:
●
32
Make sure to add all the ANS server IP addresses as trusted nodes.
Add a route.
●
Select the local IP address as trusted node.
●
Select TCP as transport.
●
Keep all the other default settings.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
●
Click Save.
6. From the Home page, go to System Configuration> Media Processing> Digit Relay
(DTMF), and then perform the following tasks:
●
Remove INFO Digits, and leave only RFC2833 as enabled.
●
Select the radio button for Specify Type: ___ (99-126), then enter 100 as the value.
●
Click Save.
7. From the Home page, go to System Status> Element Satus, and then make sure that
there are no alarms.
Installing the ANS binary file all-in-one server
1. Download the ANS binary file from the Product Licensing and Delivery System (PLDS)
site.
2. Log in to Linux shell as root or login as a user, and then sudo su - root.
3. Go to the location where you have downloaded the ANS binary file.
4. Run the ANS binary file.
For example,
./ANSSetupxxxx.bin
where the xxxx specifies the version of the downloaded ANS binary file.
The system verifies the archive integrity and decompresses ANS 2.0 installer.
The system also verifies if RHEL version 5.4, 5.5, 5.6, or 5.7 is installed.
5. Specify the following at the system prompts:
●
1 for All-in-one server installation.
●
Enter the IP address and host name.
The system creates the database and installs the ANS server.
●
Enter the AMS path.
●
Specify if you want to restore the old database.
6. After a successful installation, go to the following locations and type the ls command at
each location to verify whether the ANS binary file is installed correctly:
●
/opt/Avaya
The system lists that ANS, JBoss, SIP A/S, and WebLM are installed.
●
/usr/java
The system lists the instance of JDK.
●
/opt
The system lists the instance of Postgres.
ANS Installation and Administration guide
July 2012
33
Chapter 3: ANS implementation
7. Apply the latest ANS software patches, if available.
●
cd /root/ans2.0.xxxx/patches
●
If there are sub-folders under /root/ans2.0.xxxx/patches, then follow the instructions in
the readme.txt file under each subfolder and apply the patch. Make sure that you apply
all the patches included in the folder.
Installing the ANS binary file in the high-availability servers
Note:
Note:
Avaya recommends that you perform the installation of ANS binary on both the
servers at the same time. Installing the binaries at the same time will speed-up
the resolution of the virtual IP address during the installations.
1. Download the ANS binary file from the Product Licensing and Delivery System (PLDS)
site.
2. Log in to Linux shell as root or login as a user, and then sudo su - root.
3. Go to the location where you have downloaded the ANS binary file.
4. Run the ANS binary file.
For example: ./ANSSetupxxxx.bin, where the xxxx specifies the version of the
downloaded ANS binary file.
The system verifies the archive integrity and decompresses the ANS 2.0 installer.
The system also verifies if RHEL version 5.4, 5.5, 5.6, or 5.7 is installed.
5. Specify the following at the system prompts:
●
2 for high availability server installation.
●
Enter the local server IP address and the local host name.
●
Enter the Peer server IP address and the Peer host name.
●
Enter the virtual IP address and the virtual host name.
●
Enter the default router IP address at the system prompt for entering the Ping Node Router/Switch/Gateway IP.
●
Select y at the prompt: Is this the first server in a cluster (y/n)?, to select the first server
that is configured as the master database server.
Select n at the same prompt to configure the Peer server as the client database
server.
The system creates the database and installs the ANS server.
●
Enter the AMS path.
●
Specify if you want to restore the old database.
6. After a successful installation, go to the following locations and type the ls command at
each location to verify whether the ANS binary file is installed correctly:
34
ANS Installation and Administration guide
Comments? [email protected]
July 2012
●
/opt/Avaya
The system lists that ANS, JBoss, SIP A/S, and WebLM are installed.
●
/usr/java
The system lists the instance of JDK.
●
/opt
The system lists the instance of Postgres.
7. Apply the latest ANS software patches, if available.
●
cd /root/ans2.0.xxxx/patches
●
If there are sub-folders under /root/ans2.0.xxxx/patches, then follow the instructions in
the readme.txt file under each subfolder and apply the patch. Make sure that you apply
all the patches included in the folder.
8. (Optional) If the server bonds the eth0 and other NIC together to bond0, you must edit the
/etc/ha.d/ha.cf file and change the eth0 to bond0 in the following line, then restart the
heartbeat service. Make sure that you make the changes on both the ANS servers.
●
Change from
ucast eth0 xxx.xxx.xxx.xxx
●
Change to
ucast bond0 xxx.xxx.xxx.xxx
●
Restart the heartbeat service:
/etc/init.d/heartbeat stop
/etc/init.d/heartbeat start
Applying the ANS license
!
Important:
Important:
If you are re-installing ANS R2.0 to the same server, you can find the existing
ANS R2.0 license at /var/avaya/licenses/
wlmxxxxxxxxxxxxlicense.xml. You can skip step 1 through step 3 in the
following procedure and reuse the existing license file.
If you are upgrading from ANS R1.2 to ANS R2.0, then you cannot reuse the
existing ANS R1.2 license file. In that case, perform step 1 through step 3 to
generate the new ANS R2.0 license file.
Note:
Note:
Make sure that you perform the following procedure on both the ANS servers if
you have a HA setup.
1. Record the server MAC address in ipconfig.
ANS Installation and Administration guide
July 2012
35
Chapter 3: ANS implementation
2. Generate the ANS license from the Avaya PLDS website https://PLDS.avaya.com or from
WebLG using the server MAC addresses.
3. Download the ANS license xml file to the ANS server.
The file name appears as follows: wlm594387305160964480license.xml.
4. Open a Web browser and enter the following URL for the ANS WebLM portal:
https://xxx.xxx.xxx.xxx:52233/WebLM.
Replace xxx.xxx.xxx.xxx with the ANS server IP address.
5. Login using admin as username and weblmadmin as password, and then change the
password after first login.
6. Install the ANS License:
●
Enter the license file path.
●
Browse to the location where you have save the license file, and then click Install.
7. Check the license keys and make sure that the voice ports and media server ports are
licensed with the right amount of quantity that matches the customer order.
Upgrading to ANS 2.0
Note:
36
Note:
If you are upgrading from ANS R1.2 system, you have to schedule the upgrade in
the system maintenance time because ANS servers will be out of services during
the upgrade.
The system will migrate only the following existing R1.2 data to the new R2.0
system. The system will not copy the existing notification histories to the new
R2.0 system.
●
Users, Groups, Escalations, and User defined fields
●
Notification Scenarios
●
Registered IP Phones
●
From Addresses
●
External Conference Bridges
●
Message Inboxes
●
Email Channel Server Configurations
●
SMS Channel Clickatell Configurations
●
SIP Trunk Configurations
●
LDAP Configurations
●
Inbound Call Trigger Configurations
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Upgrading to ANS 2.0
Upgrading the all-in-1 server from R1.2 to R2.0
1. Backup the ANS R1.2 database if you want to go back to R1.2 in the future.
●
Stop the ANS services:
stopANSAll.sh
●
Start the postgresql database:
/etc/init.d/postgresql-8.3 start
●
Backup the ANS 1.2 database:
This creates the database backup file as /root/ansdbbackup1.dump.
●
cd /root/ANS-1.2-SP1-25July/ha_db_restore/
or go to the folder that has the ANS 1.2 SP1 software.
●
./backupDB1.sh
2. Export the existing R1.2 data to files.
●
Create the migration folder:
mkdir /root/ans1.2migration
●
Unzip the migration utility to /root/ans2.0.nnnn/DataMigration folder:
●
tar -xvf /root/ans2.0.nnnn/DataMigration.tar
or replace the path with the folder that has the ANS 2.0 binary.
●
If you are using the LDAP synchronization feature in R1.2, you need to start the LDAP
service:
/etc/init.d/ANSLDAPService start
●
Export the existing R1.2 data to files:
●
cd /root/ans2.0.nnnn/DataMigration
or replace the path with the folder that has the ANS 2.0 binary.
●
java -Xmx2048m -XX:-UseGCOverheadLimit -jar
DataMigration-1.2.0-SNAPSHOT.jar
- Select choice 1 for Exporting Data from ANS-1.2.
- Enter the migration folder /root/ans1.2migration
●
Check the exported files:
ls /root/ans1.2migration
3. Uninstall ANS R1.2.
●
Uninstall ANS.
Note: Run the following from the VNC terminal because it requires the GUI, and make
sure that you check the checkbox for deleting the AvayaNotificationSolution folder.
●
/etc/init.d/ANSLDAPService stop
●
/etc/init.d/postgresql-8.3 stop
ANS Installation and Administration guide
July 2012
37
Chapter 3: ANS implementation
●
cd /opt/Avaya/AvayaNotificationSolution/Uninstaller
●
java -jar uninstaller.jar
Make sure that you select the removing folder checkbox.
●
Uninstall Jade and SIPAS.
/root/ANS-R1.2-04182011/uninstalljade.sh
/root/ANS-R1.2-04182011/uninstallsipas.sh
●
Change the home directory for the postgres user:
usermod -d /opt/postgres/9.0/ postgres
●
Reboot the server after uninstalling the ANS.
Note: You do not need to uninstall the Loquendo TTS because you can reuse the
same in ANS R2.0.
4. Follow the new ANS R2.0 installation procedure to install and configure AMS. Then install
ANS and apply the ANS R2.0 licenses.
Note: You do not need to reinstall the Loquendo.
5. Apply the latest ANS software patches, if available.
●
cd /root/ans2.0.xxxx/patches
●
If there are sub-folders under /root/ans2.0.xxxx/patches, then follow the instructions
in the readme.txt file under each subfolder and apply the patch.
Make sure that you apply all the patches included in the folder.
6. Import the existing R1.2 data to the R2.0 database.
Note: You can import the data only once. Otherwise you would get duplicated data.
●
Import the existing R1.2 data to the R2.0 database:
●
cd /root/ans2.0.nnnn/DataMigration
or replace the path with the folder that has the ANS 2.0 binary.
●
java -Xmx2048m -XX:-UseGCOverheadLimit -jar
DataMigration-1.2.0-SNAPSHOT.jar
- Select choice 2 for Importing Data into ANS-2.0.
- Enter the migration folder /root/ans1.2migration
●
If the LDAP synchronization feature is enabled, restart the ANSJbossNode1 services
on both the ANS servers:
/etc/init.d/ANSJbossNode1 restart
●
Browse the ANS Web Portal to make sure that the R1.2 users, groups, and scenarios
are successfully migrated to the R2.0 system:
https://xxx.xxx.xxx.xxx:8443/ANSWebPortal
●
Configure TTW:
1. Go to System Configuration> Channel Configuration, then select TTW Server
from the drop down menu.
2. Change the default loop back addresses to the real ANS server IP addresses.
38
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Upgrading to ANS 2.0
●
Configure Media Servers:
1. Go to System Configuration> Resource Manager, then click on the Media
Servers tab.
2. Add a new Media Server.
Here is an example:
- Name = AMS 1
- IP Address = 190.168.50.55
- Port = 5090
- Transport = TCP
- User = 10b92e11-b933-11e0-ae79-2f44c51209f6
3. Make sure that you add two Media Servers for the high availability installation.
●
Restart the ANS services:
●
stopANS.sh
●
startANS.sh
Upgrading the HA servers from R1.2 to R2.0
1. Identify which ANS database has the most recent version of data
●
Browse to both the ANS 1.2 server management portals and identify which server has
the most recent version of data. If both have the same data, then select server 1
database for the migration.
https://xxx.xxx.xxx.xxx:8443/ManagementPortal/
2. Run the following on both the servers to back up both the ANS R1.2 databases if you want
to go back to R1.2 in the future.
●
Stop the ANS services on both the servers:
stopANSAll.sh
●
Start postgresql database on both the servers:
/etc/init.d/postgresql-8.3 start
●
Remove the symmetric backlogs on both the servers:
●
●
cd /root/ANS-1.2-SP1-25July/ha_db_restore/
or go to the folder that has the ANS 1.2 SP1 software.
●
./removeSymData.sh
Backup ANS 1.2 database on both the servers.
1. Run the following at ANS server 1.
This will create the database backup file as /root/ansdbbackup1.dump.
ANS Installation and Administration guide
July 2012
39
Chapter 3: ANS implementation
●
cd /root/ANS-1.2-SP1-25July/ha_db_restore/
or go to the folder that has the ANS 1.2 SP1 software.
●
/backupDB1.sh
2. Run the following at ANS server 2.
This will create the database backup file as /root/ansdbbackup2.dump.
●
cd /root/ANS-1.2-SP1-25July/ha_db_restore/
or go to the folder that has the ANS 1.2 SP1 software.
●
./backupDB2.sh
3. Export the existing R1.2 data to files on both the servers.
●
Create the migration folder:
mkdir /root/ans1.2migration
●
Unzip the migration utility to /root/ans2.0.nnnn/DataMigration folder:
●
tar -xvf /root/ans2.0.nnnn/DataMigration.tar
or replace the path with the folder that has the ANS 2.0 binary.
●
(Optional) If you are using the LDAP synchronization feature in R1.2, you must start
the LDAP service:
/etc/init.d/ANSLDAPService start
●
Export the existing R1.2 data to files:
●
cd /root/ans2.0.nnnn/DataMigration
or replace the path with the folder that has the ANS 2.0 binary.
●
java -Xmx2048m -XX:-UseGCOverheadLimit -jar
DataMigration-1.2.0-SNAPSHOT.jar
- Select choice 1 for Exporting Data from ANS-1.2.
- Enter the migration folder /root/ans1.2migration
●
Check the exported files:
ls /root/ans1.2migration
4. Uninstall the ANS R1.2 on both the servers.
●
40
Uninstall ANS
Note: Run the following from the VNC terminal because it requires the GUI, and make
sure that you check the checkbox for deleting the AvayaNotificationSolution folder.
●
/etc/init.d/ANSLDAPService stop
●
/etc/init.d/postgresql-8.3 stop
●
/etc/init.d/heartbeat stop
●
/etc/init.d/ANSRsyncService stop
●
cd /opt/Avaya/AvayaNotificationSolution/Uninstaller
●
java -jar uninstaller.jar
Make sure that you select the removing folder checkbox.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Upgrading to ANS 2.0
●
Uninstall Jade and SIPAS:
/root/ANS-R1.2-04182011/uninstalljade.sh
/root/ANS-R1.2-04182011/uninstallsipas.sh
●
Check if heartbeat RPM was removed successfully.
●
rpm -qa | grep heartbeat
●
Remove the heartbeat RPMs if they exist.
rpm --noscripts --nodeps -e heartbeat-3.0.2-2.el4
rpm --noscripts --nodeps -e heartbeat-libs-3.0.2-2.el4
●
Change the home directory for the postgres user:
usermod -d /opt/postgres/9.0/ postgres
●
Reboot the server after uninstalling ANS.
Note: You do not need to uninstall the Loquendo TTS because you can reuse the
same in ANS R2.0.
5. Follow the new ANS R2.0 installation procedure to install and configure AMS.
Then install ANS and apply the ANS R2.0 licenses.
Note: You do not need to reinstall the Loquendo.
6. Apply the latest ANS software patches, if available.
●
cd /root/ans2.0.xxxx/patches
●
If there are sub-folders under /root/ans2.0.xxxx/patches, then follow the instructions
in the readme.txt file under each subfolder and apply the patch.
Make sure that you apply all the patches included in the folder.
7. Migrate the existing R1.2 data into the R2.0 database.
●
●
Import the existing R1.2 data to the R2.0 database:
Note: Run the following only from the server that has the most recent data.
The R2.0 database sync will automatically synchronize the databases on both the
servers.
You can import the data only once. Otherwise you would get duplicated data.
●
cd /root/ans2.0.nnnn/DataMigration
or replace the path with the folder that has the ANS 2.0 binary.
●
java -Xmx2048m -XX:-UseGCOverheadLimit -jar
DataMigration-1.2.0-SNAPSHOT.jar
- Select choice 2 for Importing Data into ANS-2.0.
- Enter the migration folder, that is, /root/ans1.2migration
Restore the property files in the other server:
Note: Since the file sync program only synchronize the wav files in the /opt/aps/notify
folder between two servers, some property files need to be restored from R1.2 to R2.0
on the other ANS servers.
Run the following script only on the other server where you did not run the
DataMigration-1.2.0-SNAPSHOT.jar command earlier.
ANS Installation and Administration guide
July 2012
41
Chapter 3: ANS implementation
●
cd /root/ans2.0.nnnn/DataMigration
or replace the path with the folder that has the ANS 2.0 binary.
●
./restorePropertyFile.sh
Enter the migration folder, that is, /root/ans1.2migration
●
If the LDAP synchronization feature is enabled, restart the ANSJbossNode1 services
on both the ANS servers:
/etc/init.d/ANSJbossNode1 restart
●
Browse the ANS Web Portal to make sure that the R1.2 users, groups, and scenarios
are successfully migrated to the R2.0 system:
https://nnn.nnn.nnn.nnn:8443/ANSWebPortal
Replace the above nnn.nnn.nnn.nnn with the virtual IP address.
●
Configure TTW:
1. Go to System Configuration> Channel Configuration, then select TTW Server
from the drop down menu.
2. Change the default loop back addresses to the real ANS server IP addresses.
●
Configure Media Servers:
1. Go to System Configuration > Resource Manager, then click on the Media
Servers tab.
2. Add a new Media Server.
Here is an example:
- Name = AMS 1
- IP Address = 190.168.50.55
- Port = 5090
- Transport = TCP
- User = 10b92e11-b933-11e0-ae79-2f44c51209f6
3. Make sure that you add two Media Servers for the high availability installation.
●
(Optional) If you are using the LDAP synchronization feature in R2.0, then perform the
following steps to configure the LDAP:
1. Open two separate browser sessions and browse to both the ANS physical IP
addresses (not virtual IP):
●
https://xxx.xxx.xxx.xxx:8443/ANSWebPortal
●
https://yyy.yyy.yyy.yyy:8443/ANSWebPortal
2. From both browsers, go to System Configuration> LDAP Configuration, then
click on the LDAP tab.
3. Copy and paste the correct LDAP configurations from one browser to the other
browser.
●
Restart the ANS services on both the servers:
1. Restart the ANS services on the first ANS server:
42
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Upgrading to ANS 2.0
●
stopANS.sh
●
startANS.sh
2. Wait for 2 minutes after the first ANS server completed the restarting, then restart
the ANS services on the second ANS server:
●
stopANS.sh
●
startANS.sh
Re-installing ANS 2.0 in the same servers
Note:
Note:
You must schedule the maintenance window for this activity because you will
have to stop all the ANS server services.
Before you reinstall ANS, you must uninstall the existing ANS R2.0 program using
the uninstallation procedure mentioned in this document first, and then install the
new ANS R2.0.
You can keep the existing installed AMS and Loquendo TTS unchanged.
Re-installing the all-in-one server:
1. Uninstall ANS:
●
Stop the ANS services:
stopANS.sh
●
Uninstall ANS:
/opt/Avaya/AvayaNotificationSolution/uninstaller/uninstall.bin
●
Reboot the server after uninstalling ANS.
2. Run the ANS binary file:
For example:
./ANSSetupxxxx.bin, where the xxxx specifies the version of the downloaded ANS
binary file.
●
Select 1 for all-in-1 installation.
●
Complete on-screen questions for IP addresses and the host names.
●
Select y for restoring the database from backup.
3. Apply the ANS license:
●
Copy the backup ANS license file to your computer.
The backup ANS license file is stored at /var/avaya/licenses/
wlmxxxxxxxxxxxxxxxxxlicense.xml.
ANS Installation and Administration guide
July 2012
43
Chapter 3: ANS implementation
●
Browse to the ANS WebLM portal: https://xxx.xxx.xxx.xxx:52233/WebLM
Replace xxx.xxx.xxx.xxx with the current ANS server IP address.
●
Login using admin and weblmadmin as the username and the password respectively,
and then change the password.
●
Apply the ANS License after a successful login.
●
Check the license keys.
Make sure that the voice ports and the media server ports are licensed with the right
amount of quantity as customer ordered.
4. Check the ANS status:
ANSStatus.sh
Note: Ignore the last failure item on TTS wav file creations.
Re-installing the HA servers:
Note:
Note:
Whether you are reinstalling the same version of ANS R2.0 software or a newer
version, you must reinstall the ANS software on both the servers at the same time
to ensure that both the servers have the same version of the software and the
servers are back to the synchronized state.
1. Back up the current database.
●
Find out which node is the master node (the master node has the virtual IP address).
Typically the master node live database should be used for restoring the HA database
after the re-installation, unless the current database is already corrupted.
Use the ifconfig command on both the servers and the master node server should
have an interface that looks like eth0:0 that has the virtual IP address.
●
Put both node A and node B into the HA stopped state by running the following
command on both the servers:
/opt/Avaya/AvayaNotificationSolution/tmp/haStopANS.sh
●
Backup the existing database on Node A and Node B if the master database's backup
file is corrupted. This creates the backup file at the following location:
/var/avaya/ans/ansdb.
/opt/Avaya/AvayaNotificationSolution/tmp/
ansHABackupLiveMasterDB.sh
2. Uninstall node A and node B at the same time:
●
Uninstall ANS:
/opt/Avaya/AvayaNotificationSolution/uninstaller/uninstall.bin
●
Reboot the server after uninstalling ANS.
3. Install ANS R2.0 on node A and node B at the same time:
●
44
On the node A server:
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Upgrading to ANS 2.0
1. Run the ANS binary file.
For example, ./ANSSetupxxxx.bin, where the xxxx specifies the version of the
downloaded ANS binary file.
2. Select 2 for high availability server installation.
3. Complete the on-screen questions for IP addresses and the host names.
4. Select y when the system prompts if it is the first server in the ANS cluster.
●
On the node B server:
1. Run the ANS binary file.
For example, ./ANSSetupxxxx.bin, where the xxxx specifies the version of the
downloaded ANS binary file.
2. Select 2 for high availability server installation.
3. Complete the on-screen questions for IP addresses and the host names.
4. Select n when the system prompts if it is the first server in the ANS cluster.
4. Restore the HA database:
●
Select a good backup file and copy to both servers as /var/avaya/ans/ansdb
●
For example, if the master note's backup file /var/avaya/ans/ansdb is in node A,
you can copy the backup file to node B.
Note: Rename the existing /var/avaya/ans/ansdb on node B to another name
before running the following command to avoid the override.
a. scp /var/avaya/ans/ansdb root@node_B_IP:/var/avaya/ans/
ansdb
●
For example, if the earlier date of the backup file on node A is what you want, you
should copy it to /var/avaya/ans/ansdb first then copying to node B
Note: Rename the existing /var/avaya/ans/ansdb on node B to another name
before running the following command to avoid the override:
a. cp /var/avaya/ans/ansdb-xx-xx-xx /var/avaya/ans/ansdb
b. scp /var/avaya/ans/ansdb root@node_B_IP:/var/avaya/ans/
ansdb
●
Put both node A and node B into HA stopped state by running the following command
on both servers:
/opt/Avaya/AvayaNotificationSolution/tmp/haStopANS.sh
●
Run the following script to recover the database on both node A and node B:
●
●
/opt/Avaya/AvayaNotificationSolution/tmp/ansHARestoreDB.sh
●
Make sure to select no when prompted for do you wish to start.
This will leave both the nodes in HA stopped state after the restoration.
Restart the ANS HA services on both the nodes:
Run the following script on node A first and then wait for five seconds. Then run the
ANS Installation and Administration guide
July 2012
45
Chapter 3: ANS implementation
same script on node B.
This sequnecing ensures that node A gets the virtual IP and becomes the master
node.
●
/opt/Avaya/AvayaNotificationSolution/tmp/haStartANS.sh
5. Apply the ANS license on both the servers:
●
Copy the backup ANS license file to your computer.
The backup ANS license file is stored at: /var/avaya/licenses/
wlmxxxxxxxxxxxxxxxxxlicense.xml.
●
Browse to the ANS WebLM portal https://xxx.xxx.xxx.xxx:52233/WebLM.
Replace xxx.xxx.xxx.xxx with the current ANS server IP address.
●
Login using admin and weblmadmin as the username and the password respectively,
and then change the password.
●
Apply the ANS License after a successful login.
●
Check the license keys.
Make sure that the voice ports and the media server ports are licensed with the right
amount of quantity as customer ordered.
6. Check the ANS status:
ANSStatus.sh
Note: Ignore the last failure item on TTS wav file creations.
7. Verif that the server is installed successfully:
●
Browse to the ANS Web Portal https://xxx.xxx.xxx.xxx:8443/ANSWebPortal Replace
xxx.xxx.xxx.xxx with the virtual IP address.
●
Login as admin with the existing password.
●
Make sure that both the channels from both the ANS servers are active under the
Channel Status page.
Uninstalling ANS
1. Stop the ANS services:
●
For All-in-1 Server, run the following:
stopANS.sh
●
For HA servers, run the following:
/opt/Avaya/AvayaNotificationSolution/tmp/haStopANS.sh
2. Uninstall ANS:
/opt/Avaya/AvayaNotificationSolution/uninstaller/uninstall.bin
3. Reboot the server after uninstalling the ANS.
46
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Uninstalling ANS
Note:
Note:
If you canceled the installation in the middle of ANS binary, the above
un-installation may not work for you. You will have to clean up the system
manually with the following steps:
Perform the following tasks to clean up the syetem manually:
1. To verify the ANS RPMs:
●
rpm -qa | grep ans-2.0
●
rpm -qa | grep jboss
●
rpm -qa | grep postgres
●
rpm -qa | grep weblm
●
rpm -qa | grep sipas
●
rpm -qa | grep heartbeat
2. Remove the RPMs if they exist.
For example, if the ANS RPM still exists as ans-2.0-SNAPSHOT20120706093400, run the
following command to manually remove the ANS RPM:
rpm --noscripts -e ans-2.0-SNAPSHOT20120706093400
3. Run the following command to make sure that the SIPAS process is not running.
If the process is still running, the following command ends the process.
ps -ef |grep SIPAS
4. Reboot the server after uninstalling the ANS.
Note:
Note:
You do not have to uninstall AMS during the ANS upgrade. If you still need to
uninstall AMS, then run the following command:
/opt/avaya/UninstallMediaServer/UninstallMediaServer
See the Installing, Upgrading, and Patching Avaya Media Server 7_5.pdf
document from the Avaya Media Server documentation section in the Avaya
Support Site for more information.
ANS Installation and Administration guide
July 2012
47
Chapter 3: ANS implementation
48
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Chapter 4: Quick configuration of ANS
After implementing ANS, configure the ANS settings using the ANS Management Portal as
discussed in the following sections.
After implementing ANS, configure the ANS settings using the ANS Management Portal as
discussed in the following sections.
!
Important:
Important:
Make sure that you restart the ANS services with the following commands after
the configuration. For the ANS High Availability setup, complete restarting the
ANS services on the first ANS server and wait for 2 minutes. Then restar the ANS
services on the second ANS server:
- stopANS.sh
- startANS.sh
Logging in to the ANS Management Portal
1. Open a Web browser and enter the following URL for the ANS Management Portal:
https://xxx.xxx.xxx.xxx:8443/ANSWebPortal
Replace xxx.xxx.xxx.xxx with the ANS server IP address or with the virtual IP address.
2. Login using admin as the default username and Ans,444001 as the default password.
3. Change the password after your first successful login.
(Optional) Resetting the admin password to default value
If you forget the admin password or the admin password is locked, run the following script from
the ANS server Linux prompt to reset the admin password to the default value:
/opt/Avaya/AvayaNotificationSolution/config/resetAdminPassword.sh
Run the script only at one of the ANS servers if you have an ANS High Availability setup.
ANS Installation and Administration guide
July 2012
49
Chapter 4: Quick configuration of ANS
Add the Permitted and Trusted IP
●
Go to System Configuration> Coordinator Configuration> Permitted Driver IP, and
then add the ANS Virtual IP address as the permitted driver IP address.
●
Go to System Configuration> Security Configuration> Web Services Trusted
Servers, and then add the ANS Virtual IP address and the physical servers IP addresses
as permitted driver IP address.
Configuring email channels
1. From the navigation pane, go to System Configuration> Channel Configuration.
The system displays the Channel Configurations page.
2. Select email channel from the drop down menu.
3. Set the mail.smtp.host
4. Set the mail.smtp.host.redundant
5. Stop the email services in both the master server and the client server after configuring the
email channel:
/etc/init.d/ANSEmailChannel stop
6. Start the email services in both the master server and the client server after configuring the
email channel:
/etc/init.d/ANSEmailChannel start
Configuring the TTW servers
Note:
Note:
Even if you do not have the Loquendo Text To Speech installed on the system you
still need to configure the TTW server because the TTW server is also used for
the HTTP file server.
For more information on setting up the system without Loquendo Text To Speech,
see Appendix I: Configuring the system voice prompts with or without Loquendo
Text To Speech on page 127 in this document.
1. From the navigation pane, go to System Configuration > Channel Configuration.
The system displays the Channel Configurations page.
2. Select TTW Server from the drop down menu.
50
ANS Installation and Administration guide
Comments? [email protected]
July 2012
3. If you have an all-in-one server setup, you can set both the TTW server IP addresses to be
the same as the ANS server IP addresses. If you have an HA server setup, you can set
both the TTW server IP addresses to both the ANS server IP addresses.
Configuring SIP Trunks
1. From the navigation pane, go to System Configuration > Resource Manager.
2. Select the SIP Trunks tab.
The system displays the SIP Trunks page.
3. Add a new SIP trunk by entering the following parameters:
●
Name: The name of the SIP trunk. For example, CM6 in New York.
●
Domain: The domain name of the SIP trunk.
●
Address: The IP address or Fully Qualified Domain Name (FQDN) of the SIP trunk.
For example, 190.168.50.32.
●
Transport: In the Transport field, click TCP or UDP.
●
Length: The length of the SIP trunk that specifies the threshold for applying the
routing parameters. For example, 7.
●
Country Code: The international dial code for the country in which the SIP trunk
exists. For example, 1.
●
Long Distance Prefix: The domestic long distance prefix for the network to which the
SIP trunk is connected. For example, 1.
●
Intl Access Code: The access code required by the trunk for accessing international
numbers. For example, 011.
●
PSTN Prefix: The Public Switched Telephone Network (PSTN) prefix number. For
example, *9.
●
Extension Port Count: The number of ports allocated to the extension calls within this
SIP trunk group. For example, 100.
●
Transport Port No: The transport port number of the SIP trunk. The default transport
port number is 5060.
●
PSTN Port Count: The number of ports allocated to the PSTN calls within this SIP
trunk group. For example, 20.
●
Priority: Enter a number from 1 through 10, including numbers 1 and 10. The number
1 has the highest priority.
●
MX Port Count: The number of ports allocated to the Meeting Exchange (MX) calls
within this trunk group. For example, 0.
ANS Installation and Administration guide
July 2012
51
Chapter 4: Quick configuration of ANS
●
Note:
Aggregation Port Count: The total port count limit for a given trunk group. For
example, 100.
Note:
Make sure that you configure the SIP trunks on the IP PBX to work with ANS.
●
If you have an ANS HA setup and you configure ANS SIP trunk to point to the IP
PBX address x, then make sure that the IP PBX address x can accept calls from
both the ANS server IP addresses. For example, for each Communication
Manager clan or procr IP address that ANS points to, you must create two SIP
trunks and signaling groups that point to both the ANS servers.
●
FQDN is not required in the IP PBX SIP trunk SIP domain configuration. But if you
configure the FQDN as SIP domain in the IP PBX SIP trunk, then make sure that
ANS SIP trunk domain field matches the same FQDN.
●
ANS can support both G.711 and G.729 codec through SIP trunk. Avaya
recommends the G.711 code as the first choice to ensure the highest voice quality
and answer machine detection accuracy.
●
If you configure IP PBX to route some extensions or DID to ANS for inbound call
triggers, you can run the traceSAS command from the ANS Linux prompt to
capture the SIP INVITE coming from the IP PBX, and find out the number of digits
in the To header. The inbound phone numbers you configure on ANS must match
exactly with the phone number in the To header.
4. Stop the voice channel services in both the master server and the client server after
entering the SIP trunk parameters:
/etc/init.d/ServiceHost0 stop
5. Start the voice channel services in both the master server and the client server after
entering the SIP trunk parameters:
/etc/init.d/ServiceHost0 start
Configuring media server resources
1. From the navigation pane, go to System Configuration> Resource Manager.
2. Select the Media Server tab.
3. Add a new media server by entering the following parameters:
52
●
Name: The name of the media server. For example, AMS 1.
●
IP Address: The IP address of the media server. For example, 190.168.50.55.
●
Port: The port number of the media server. For example, 5090.
●
Transport: Enter TCP.
●
User: Keep the default value as 10b92e11-b933-11e0-ae79-2f44c51209f6.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Tip:
Add two media servers if you have the high availability servers.
Tip:
Configuring the SMS channel with Clickatell Service
1.
Note:
Sign up the Clickatell Service:
Note:
Make sure that you set up the valid accounts on the http://www.clickatell.com
website. You can sign up the small business account if you accept the following
volume limits. Otherwise you would be required to sign up for the enterprise
account.
1. 10 message per second
2. Max 5000 messages every 24 hours
3. Max 10,000 messages per month
2. After logging into the Clickatell website, under the Manage my Products menu bar, add a
connection for SOAP and HTTP type.
3. For the US small business account, a 10 digit phone number must be ordered. Make sure
that you configure this phone number to be associated with the SOAP API.
4. Make sure to purchase enough credits for the future SMS usage.
Configuring the ANS SMS Channel
The SMS channel specifies the account details of the approved SMS provider.
1. From the navigation pane, click System Configurations> Channel Configurations.
The system displays the Channel Configurations page.
2. Select SMS Channel from the drop down menu.
3. Set the Clickatell_apiid, Clickatell_password, and Clickatell_user.
4. Set the IS_TWO_WAY property to FALSE.
5. Make sure the CONNECTOR_TYPE is set to ClickatellConnector.
Note:
Note:
If ANS needs to go through the Internet Proxy to reach the Clickatell, make sure
that you configure the proxyPort and proxyServer on the next page.
6. Stop the sms services in both the master server and the client server after configuring the
SMS channel:
/etc/init.d/ANSSMSChannel stop
ANS Installation and Administration guide
July 2012
53
Chapter 4: Quick configuration of ANS
7. Start the sms services in both the master server and the client server after configuring the
SMS channel:
/etc/init.d/ANSSMSChannel start
Configuring IP Phones to work with the ANS IP Phone Channel
●
For Avaya 96xx and 46xx series of IP phones, set the following parameters in the
46xxsettings.txt file:
●
For the all-in-1 installation:
Replace the xxx.xxx.xxx.xxx with the ANS IP address.
- SET WMLHOME http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/HomePage.action
- SET SUBSCRIBELIST http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/
SubscribeClientServlet
- SET TPSLIST xxx.xxx.xxx.xxx:8080
- SET PUSHCAP 2222
- SET PUSHPORT 80
●
For the high-availability installation:
Rreplace the xxx.xxx.xxx.xxx and yyy.yyy.yyy.yyy with both the ANS IP addresses, and
the zzz.zzz.zzz.zzz with the virtual IP address.
- SET WMLHOME http://zzz.zzz.zzz.zzz:8080/IpPhoneChannel/HomePage.action
- SET SUBSCRIBELIST http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/
SubscribeClientServlet, http://yyy.yyy.yyy.yyy:8080/IpPhoneChannel/
SubscribeClientServlet
- SET TPSLIST xxx.xxx.xxx.xxx:8080, yyy.yyy.yyy.yyy:8080
- SET TPSLIST xxx.xxx.xxx.xxx:8080
- SET PUSHCAP 2222
- SET PUSHPORT 80
●
For Avaya (Nortel) 11xx, 12xx, and 2007 series of IP phones, set the following Push Agent
and WML parameters in the System.PRV file:
●
For the all-in-1 installation:
Replace the xxx.xxx.xxx.xxx with the ANS IP address.
- Push Agent parameters:
- pp=80
- pcap=2222
- tpsl=xxx.xxx.xxx.xxx:8080
- sl=http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/SubscribeClientServlet
54
ANS Installation and Administration guide
Comments? [email protected]
July 2012
- WML parameters:
- wp=80
- wh=http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/HomePage.action
●
For the high-availability installation:
Replace the xxx.xxx.xxx.xxx and yyy.yyy.yyy.yyy with both the ANS IP addresses, and
the zzz.zzz.zzz.zzz with the virtual IP address.
- Push Agent parameters:
- pp=80
- pcap=2222
- tpsl=xxx.xxx.xxx.xxx:8080, yyy.yyy.yyy.yyy:8080
- sl=http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/SubscribeClientServlet,http://
yyy.yyy.yyy.yyy:8080/IpPhoneChannel/SubscribeClientServlet
- WML parameters:
- wp=80
- wh=http://zzz.zzz.zzz.zzz:8080/IpPhoneChannel/HomePage.action
●
Reboot the IP phones so that the IP phones can be registered to ANS servers.
You can reboot the IP phones through power cycle the closet POE switches, or through
sending commands to IP-PBX.
Configuring the Meeting Exchange to work with ANS
●
Make sure to configure the Meeting Exchange /usr/ipcb/config/system.cfg file for
listening on the SIP TCP, not SIP TLS.
●
Configure the moderator/participant codes as DID phone numbers into the cbutil table with
Direct mode. You can also use wildcard for the entry:
●
cbutil add 4??? 0 100 1 Y DIRECT
●
The above command would add the entry 4??? wildcard into the cbutil table.
●
When you book the conference with any moderator/participant codes as 4xxx, it would
allow anybody that dials 4xxx can join the conference without prompting moderator/
participant codes. This would also allow ANS to transfer users into the conference
directly without entering security codes.
ANS Installation and Administration guide
July 2012
55
Chapter 4: Quick configuration of ANS
56
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Quick testing of ANS configurations
Chapter 5: Quick testing
Quick testing of ANS configurations
To test the ANS configuration:
1. Open a Web browser and enter the following URL for the ANS Management Portal:
https://xxx.xxx.xxx.xxx:8443/ANSWebPortal
Replace the xxx.xxx.xxx.xxx with the ANS server IP address or with the virtual IP address.
2. Create some testing users with testing phone numbers, email addresses, SMS addresses,
and IP phone extensions.
From the main menu, go to Users and Groups> Users, and then click Add.
3. Create a test scenario with voice and email messages, and select the testing users.
●
From the main menu, go to Notification and Trigger> Notification Scenarios, and then
click Add.
●
After the system creates the scenario, click Trigger Preview, and then scroll down to click
Trigger.
4. Create a test scenario with SMS message, and select the testing users.
5. Create a test scenario with IP Phone message, and select the testing users.
ANS Installation and Administration guide
July 2012
57
Chapter 5: Quick testing
58
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Adding a From Address and Display Name
Chapter 6: Administering the ANS system
configurations
The Administering the ANS system configurations section describes the procedure of
configuring various channels, resource manager, and trigger configurations.
With trigger configurations, you can add display name, e-mail trigger mailbox, and inbound
number for triggering notification scenarios.
Note:
Note:
If you want to upload your existing wav file to ANS web portal, make sure that
there is no space in the wav file name.
Adding a From Address and Display Name
Display name specifies the sender who has sent the notification scenario. In case of the E-mail
channel, the display name specifies the mail-address from which the system sends the
notification to the recipients. In case of the Voice channel, the display name specifies the name
of the caller who sends the notification to the recipients.
To add display name:
1. In the navigation pane, click System Configuration > From Addresses.
The system displays the From Address page.
2. Select the From Display Name tab.
The system displays the From Display Name page.
3. Click Add.
The system displays the Add Display Name dialog box.
4. Enter the following parameters:
●
*Channel: In the Channel field, click Email or Voice.
ANS Installation and Administration guide
July 2012
59
Chapter 6: Administering the ANS system configurations
●
Display Name: The display name of the selected channel.
For the Email channel, the system automatically adds the newly added display name
in the Display Name field on the New Notification > Add Email Message page.
For the Voice channel, the system automatically adds the newly added display name
in the Display Name drop-down list box on the All Notification Scenarios > Add
Voice Message page.
The system also displays the newly added display names as Caller ID name on the
phone.
●
Default Address: To mark the added from address as your default from address,
select the Default Address check box.
●
Partition: In the Partition field, click the partition you want to select.
5. Click Save.
The system displays the Success pop-up window.
6. Click Close.
Configuring voice channel resources
To setup the voice channel resources, you must configure the following:
●
Configuring the TTW servers
●
Configuring TTS Locales
●
Configuring Resource Manager
●
Configuring media server resources
●
Configuring SIP trunk resources
Configuring the TTW servers
Note:
Note:
Even if you do not have the Loquendo Text To Speech installed on the system you
still need to configure the TTW server because the TTW server is also used for
the HTTP file server.
For more information on setting up the system without Loquendo Text To Speech,
see Appendix I: Configuring the system voice prompts with or without Loquendo
Text To Speech on page 127 in this document.
60
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Configuring voice channel resources
1. From the navigation pane, go to System Configuration > Channel Configuration.
The system displays the Channel Configurations page.
2. Select TTW Server from the drop down menu.
3. If you have an all-in-one server setup, you can set both the TTW server IP addresses to be
the same as the ANS server IP addresses. If you have an HA server setup, you can set
both the TTW server IP addresses to both the ANS server IP addresses.
Configuring the TTS Locales
1. From the navigation pane, go to System Configuration > Resource Manager.
2. Select the TTS Locales tab.
3. Enable only the TTS languages that you are licensed to, for example, English-United
States, and then click Save.
Configuring Resource Manager
The Resource Manager manages the voice resources including licensed ports, SIP trunks,
media servers, and maximum ports allowed for the partition.
To configure resource manager:
1. In the navigation pane, click System Configuration > Resource Manager.
The system displays the Resource Manager Configuration page.
2. Enter the following parameters by selecting a property row, and click Edit:
●
MAX_EXTENSION_LENGTH: The extension length of Resource Manager. Resource
Manager uses this length to determine whether Resource Manager must select an
EXTENSION trunk resource type or a PSTN trunk resource type for placing a call. If
the number of digits in the particular phone number that you need to dial is less than or
equal to MAX_EXTENSION_LENGTH, that is up to the first PAUSE p, then the system
selects an EXTENSION trunk resource type. Else, the system selects the PSTN trunk
resource type.
3. Click Save.
Configuring media server resources
1. From the navigation pane, go to System Configuration> Resource Manager.
2. Select the Media Server tab.
3. Add a new media server by entering the following parameters:
ANS Installation and Administration guide
July 2012
61
Chapter 6: Administering the ANS system configurations
●
Name: The name of the media server. For example, AMS 1.
●
IP Address: The IP address of the media server. For example, 190.168.50.55.
●
Port: The port number of the media server. For example, 5090.
●
Transport: Enter TCP.
●
User: Keep the default value as 10b92e11-b933-11e0-ae79-2f44c51209f6.
Tip:
Add two media servers if you have the high availability servers.
Tip:
Configuring SIP trunk resources
Perform the following procedures.
Connecting ANS to Communication Manager
Note:
Note:
You must configure the Communication Manager SIP Signal Group with TCP
type, port 5060, and point to the ANS physical IP address (not the virtual IP
address). You must build at least 2 SIP Signal Groups and point to each ANS
server if you have an ANS HA system. The SIP Signaling Group Far-end
Domain must be either empty or FQDN.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to Communication Manager, select the following properties,
and click Edit:
62
●
IP Address: Enter the IP address of the Communication Manager Processor Ethernet
or CLAN.
●
Domain: Must match with the value in the Communication Manager SIP Signaling
Group’s Far-end Domain field. If the Communication Manager SIP Signaling Group
Far-end Domain is empty, you can leave this ANS SIP trunk domain field empty.
●
Transport: Must enter TCP. Make sure that the Communication Manager SIP
Signaling Group also use TCP type.
●
Extension Length: For example, 7.
●
Country Code: For example, 1.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Configuring voice channel resources
●
Long Distance Prefix : For example, 1.
●
Intl Access Code: For example, 011.
●
PSTN Prefix: For example, 9.
●
Extension Port Count: For example, 100.
●
Transport Port No: Must enter 5060.
●
PSTN Port Count: For example, 20.
●
Priority: For example, 1.
●
MX Port Count: Must enter 0.
●
Aggregation Port Count: For example, 100.
4. Click Save.
Connecting ANS to CS1000
Note:
Note:
You must configure the CS1000 SIP trunk with TCP type, port 5060, and point to
the ANS physical IP address (not the virtual IP address). You must build 2 SIP
Trunks and point to each ANS server if you have an ANS HA system.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to CS1000, select the following properties, and click Edit:
●
IP Address: Enter the CS1000 Node IP address.
●
Domain: Must match with the value in the CS1000 SIP Trunk SIP Domain field.
●
Transport: Must enter TCP. Make sure that the CS1000 SIP Trunk enables the TCP
transport.
●
Extension Length: For example, 7.
●
Country Code: For example, 1.
●
Long Distance Prefix : For example, 1.
●
Intl Access Code: For example, 011.
●
PSTN Prefix: For example, 9.
●
Extension Port Count: For example, 100.
●
Transport Port No: Must enter 5060.
●
PSTN Port Count: For example, 20.
ANS Installation and Administration guide
July 2012
63
Chapter 6: Administering the ANS system configurations
●
Priority: For example, 1.
●
MX Port Count: Must enter 0.
●
Aggregation Port Count : For example, 100.
4. Click Save.
Connecting ANS to Session Manager
Note:
Note:
You must configure the Session Manager SIP trunk with TCP type, port 5060, and
add the ANS physical IP address (not the virtual IP address) as trusted node.
You must add both ANS server physical IP addresses as trusted nodes if you
have an ANS HA system.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to Session Manager, select the following properties, and click
Edit:
●
IP Address: Enter the Session Manager IP address.
●
Domain: Enter the Session Manager SIP domain, or leave the field empty.
●
Transport: Must enter TCP. Make sure that the Session Manager SIP Trunk also
enables the TCP transport.
●
Extension Length: For example, 7.
●
Country Code: For example, 1.
●
Long Distance Prefix: For example, 1.
●
Intl Access Code: For example, 011.
●
PSTN Prefix: For example, 9.
●
Extension Port Count: For example, 100.
●
Transport Port No: Must enter 5060.
●
PSTN Port Count: For example, 20.
●
Priority: For example, 1.
●
MX Port Count: Must enter 0.
●
Aggregation Port Count: For example, 100.
4. Click Save.
64
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Configuring voice channel resources
Connecting ANS to SES
Note:
Note:
You must add both the ANS server physical IP addresses as trusted hosts if you
have an ANS HA system.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to SES, select the following properties, and click Edit:
●
IP Address: Enter the SES IP address.
●
Domain: Enter the SES SIP domain, or leave the field empty.
●
Transport: Must enter TCP.
●
Extension Length: For example, 7.
●
Country Code: For example, 1.
●
Long Distance Prefix: For example, 1.
●
Intl Access Code: For example, 011.
●
PSTN Prefix: For example, 9.
●
Extension Port Count: For example, 100.
●
Transport Port No: Must enter 5060.
●
PSTN Port Count: For example, 20.
●
Priority: For example, 1.
●
MX Port Count: Must enter 0.
●
Aggregation Port Count: For example, 100.
4. Click Save.
Connecting ANS to IP Office
Note:
Note:
You must add both the ANS server physical IP addresses as trusted hosts if you
have an ANS HA system.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
ANS Installation and Administration guide
July 2012
65
Chapter 6: Administering the ANS system configurations
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to IP Office, select the following properties, and click Edit:
●
IP Address: Enter IP Office server IP address.
●
Domain: Enter the IP Office SIP domain, or leave the field empty.
●
Transport: Must enter TCP.
●
Extension Length: For example, 7.
●
Country Code: For example, 1.
●
Long Distance Prefix: For example, 1.
●
Intl Access Code: For example, 011.
●
PSTN Prefix: For example, 9.
●
Extension Port Count: For example, 100.
●
Transport Port No: Must enter 5060.
●
PSTN Port Count: For example, 20.
●
Priority: For example, 1.
●
MX Port Count: Must enter 0.
●
Aggregation Port Count: For example, 100.
4. Click Save.
Connecting ANS to Audiocodes SIP gateway
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to Audiocodes SIP gateway, select the following properties,
and click Edit:
66
●
IP Address: Enter the SIP Gateway IP Address.
●
Domain: Enter the SIP Gateway SIP domain, or leave the field empty.
●
Transport: Must enter TCP.
●
Extension Length: For example, 7.
●
Country Code: For example, 1.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Configuring voice channel resources
●
Long Distance Prefix: For example, 1.
●
Intl Access Code: For example, 011.
●
PSTN Prefix: For example, 9.
●
Extension Port Count: For example, 100.
●
Transport Port No: Must enter 5060.
●
PSTN Port Count: For example, 20.
●
Priority: For example, 1.
●
MX Port Count: Must enter 0.
●
Aggregation Port Count: For example, 100.
4. Click Save.
Connecting ANS to Session Border Controller
Note:
Note:
You must configure the Session Border Controller private side of SIP trunk with
TCP type, port 5060, and add the ANS physical IP address (not the virtual IP
address) as trusted node. You must add both ANS server physical IP addresses
as trusted nodes if you have an ANS HA system.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to Session Border Controller, select the following properties,
and click Edit:
●
IP Address: Enter the SBC Trusted Side of IP Address.
●
Domain: Enter the SBC SIP domain, or leave it empty.
●
Transport: Must enter TCP.
●
Extension Length: For example, 7.
●
Country Code: For example, 1.
●
Long Distance Prefix: For example, 1.
●
Intl Access Code: For example, 011.
●
PSTN Prefix: For example, 9.
●
Extension Port Count: For example, 100.
●
Transport Port No: Must enter 5060.
ANS Installation and Administration guide
July 2012
67
Chapter 6: Administering the ANS system configurations
●
PSTN Port Count: For example, 20.
●
Priority: For example, 1.
●
MX Port Count: Must enter 0.
●
Aggregation Port Count: For example, 100.
4. Click Save.
Connecting ANS to Meeting Exchange
Note:
Note:
You must configure the Meeting Exchange to listen on SIP TCP port 5060. You
also need to configure the moderator/participant code as DDI phone numbers into
the cbutil table with "Direct" mode. You can use wildcard for the entry with the
following command Meeting Exchange command:
cbutil add 4??? 0 100 1 Y DIRECT
The above command adds the entry 4??? wildcard into the cbutil table. When
you book the conference with any moderator/participant codes as 4xxx, it allows
anybody who dials 4xxx to join the conference without prompting moderator/
participant codes. This also allows ANS to transfer users into the conference
directly through SIP.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Channel/Component to configure field, click SIP Trunk.
The system displays the details of the SIP trunk in a table with Property, Value, and
Description columns.
3. To connect the ANS server to Meeting Exchange, select the following properties, and click
Edit:
68
●
IP Address: Enter the Meeting Exchange server IP address, and make sure that you
do not enter the Client Reservation Server (CRS) IP address.
●
Domain: Enter the domain name of the SIP trunk. The entry must match either with
the Meeting Exchange SIP domain, or leave field empty.
●
Transport: Must enter TCP. Make sure that the Meeting Exchange server SIP
configuration is set for listening on TCP, and not TLS.
●
Extension Length: For example, 7.
●
Country Code: For example, empty field.
●
Long Distance Prefix: For example, empty field.
●
Intl Access Code: For example, empty field.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Channel configurations
●
PSTN Prefix: For example, empty field.
●
Extension Port Count: For example, 0.
●
Transport Port No: Must enter 5060.
●
PSTN Port Count: For example, 0.
●
Priority: For example, 1.
●
MX Port Count: Must be greater than 0, for example, 100.
●
Aggregation Port Count: For example, 100.
The system would reset this value to zero which is acceptable.
4. Click Save.
Channel configurations
Configuring the channel settings
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. Enter the following parameters:
●
Select the Channel/Component to configure: In the Select the Channel/
Component to configure field, click any one of the following channel:
- Email channel
- IM_Sametime channel
- XMPP-IM channel
- IP Phone channel
- SMS channel
- TTW server
- Voice channel
- HTTP dialer
●
Property: The property of the selected channel.
3. Click Search.
The system displays the selected channel details table.
4. To edit the property of the selected channel, select a property row.
ANS Installation and Administration guide
July 2012
69
Chapter 6: Administering the ANS system configurations
5. Click Edit.
The system displays the Edit Property dialog box.
6. Enter a value to enable the property.
7. Click Save.
The system displays the Success pop-up window.
8. Click Close.
Connecting E-mail channel to SMTP relay server
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Select the Channel/Component to configure field, click the Email channel.
3. Enter the following parameters:
●
mail.smtp.host: The host name or IP address of the SMTP server.
●
mail.smtp.pass: The password of the SMTP server.
●
mail.smtp.port: The port number of the SMTP server.
Configuring the Avaya 96xx and 46xx IP phones
1. Ensure that the IP phones meet the firmware release level requirements.
2. Set the push parameters in the 46xxsettings.txt file, then reboot the IP phones after ANS is
installed so that IP phones can register to the ANS servers.
●
●
For the all-in-1 ANS system, where xxx.xxx.xxx.xxx is the ANS server IP address:
●
SET WMLHOME http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/HomePage.action
●
SET SUBSCRIBELIST http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/
SubscribeClientServlet
●
SET TPSLIST xxx.xxx.xxx.xxx:8080
●
SET PUSHCAP 2222
●
SET PUSHPORT 80
For the HA ANS system, where xxx.xxx.xxx.xxx is the ANS server 1 IP address,
yyy.yyy.yyy.yyy is the ANS server 2 IP address, and zzz.zzz.zzz.zzz is the ANS virtual IP
address:
●
70
SET WMLHOME http://zzz.zzz.zzz.zzz:8080/IpPhoneChannel/HomePage.action
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Channel configurations
●
SET SUBSCRIBELIST http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/
SubscribeClientServlet,http://yyy.yyy.yyy.yyy:8080/IpPhoneChannel/
SubscribeClientServlet
●
SET TPSLIST xxx.xxx.xxx.xxx:8080,yyy.yyy.yyy.yyy:8080
●
SET PUSHCAP 2222
●
SET PUSHPORT 80
Configuring the Avaya 11xx and 12xx IP phones
1. Ensure that the IP phones meet the firmware release level requirements.
2. Set the push parameters in the System.PRV file, then reboot the IP phones after ANS are
installed so that IP phones can register to ANS servers.
●
For the all-in-1 ANS system, where xxx.xxx.xxx.xxx is the ANS IP address:
●
●
●
Push Agent parameters:
●
pp=80;
●
pcap=2222;
●
tpsl=xxx.xxx.xxx.xxx:8080;
●
sl=http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/SubscribeClientServlet;
WML parameters
●
wp=80;
●
wh=http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/HomePage.action;
For the HA ANS system, where xxx.xxx.xxx.xxx is the ANS server 1 IP address,
yyy.yyy.yyy.yyy is the ANS server 2 IP address, and zzz.zzz.zzz.zzz is the ANS virtual IP
address:
●
●
Push Agent parameters
●
pp=80;
●
pcap=2222;
●
tpsl=xxx.xxx.xxx.xxx:8080,yyy.yyy.yyy.yyy:8080;
●
sl= http://xxx.xxx.xxx.xxx:8080/IpPhoneChannel/SubscribeClientServlet,http://
yyy.yyy.yyy.yyy:8080/IpPhoneChannel/SubscribeClientServlet;
WML parameters
●
wp=80;
●
wh=http://zzz.zzz.zzz.zzz:8080/IpPhoneChannel/HomePage.action;
ANS Installation and Administration guide
July 2012
71
Chapter 6: Administering the ANS system configurations
Configuring the ANS SMS channel for Clickatell
Using ANS, you can utilize Simple Object Access Protocol (SOAP) Web Services of Clickatell to
send one-way SMS to mobile phones. Depending on your needs, either you can sign up the
USA service account or international service accounts from Clickatell.
To find more information about the SOAP services of Clickatell, visit the following site:
http://www.clickatell.com/developers/api_soap.php
Creating a clickatell account and signing in:
1. Open the http://www.clickatell.com/developers/api_soap.php site.
2. To find out the account options and pricing, click Free Sign Up.
The system displays the following options for the USA account:
●
Small Business account
The small business account has a long 10-digit number and volume limit of 5,000
messages per day and 10,000 messages per month.
●
Enterprise account.
The enterprise account has a short code without volume limitations.
3. Select the appropriate option and click Free Sign Up.
After you sign up with the Clickatell account, the system provides your Clickatell account
details, such as your user name, client ID, and password. You can use these account
details to log on to the Clickatell site and manage your account.
4. Ensure that you select the Product Type as Central API when you log in to the Clickatell
account.
5. After logging on to the Clickatell site, under the Manage my Products menu bar, add
connections for SOAP and HTTP type.
6. Ensure that you have 10-digit phone number for the SOAP connection, and not the HTTP
connection.
Note:
Note:
The ANS SMS channel configuration uses this Clickatell SOAP connection API
ID.
After you sign up with the Clickatell account, you can perform the following steps to configure
ANS to connect to Clickatell:
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Select the Channel/Component to configure field, click SMS_channel.
The system displays the SMS server details.
3. Set the Connector_Type property to ClickatellConnector.
72
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Channel configurations
4. The Clickatell SOAP connection is one-way SMS only. Therefore, set the IS_TWO_WAY
property to False.
5. Enter any of the following value to set the SMS_ENCODING property:
●
0 for 7-bit alphabet encoding.
Each SMS message can contain 160 characters.
●
1 for 8-bit data alphabet encoding.
Each SMS message can contain 140 characters.
●
2 for 16-bit UTF-16/UCS-2 alphabet encoding for languages such as Arabic, Chinese,
Korean, Japanese, or Russian.
Each SMS message can contain 70 characters.
6. To set the Clickatell account information, enter the following property settings:
●
Clickatell_apiid: Clickatell SOAP connection API ID.
●
Clickatell_user: The user name of the Clickatell account.
●
Clickatell_password: The password of the Clickatell account.
7. If ANS needs to go through the Internet proxy to access the public Internet, then enter
values for the following parameters:
●
ProxyServer: IP address of the Internet proxy server.
●
ProxyPort: Port number of the Internet proxy server.
Configuring the ANS SMS channel for SMPP
If you require two-way SMS, you can order the standard Short Message Peer-to-Peer (SMPP)
connections from the service providers. You can use the SMPP account for the customers, who
require sending high volume messages. SMPP has minimum monthly commitment.
With two-way SMS, you can respond to the ANS SMS messages with the multiple choice
selections.
To configure a SMPP account:
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Select the Channel/Component to configure field, click SMS_channel.
The system displays the SMS server details.
3. Set the Connector_Type property to SimServerConnector.
4. Set the IS_TWO_WAY property to True.
5. Set the SMS_ENCODING property to any one of the following:
ANS Installation and Administration guide
July 2012
73
Chapter 6: Administering the ANS system configurations
●
0 for 7-bit alphabet encoding.
Each SMS message can contain 160 characters.
●
1 for 8-bit data alphabet encoding.
Each SMS message can contain 140 characters.
●
2 for 16-bit UTF-16/UCS-2 alphabet encoding for languages such as Arabic, Chinese,
Korean, Japanese, or Russian.
Each SMS message can contain 70 characters.
6. Click Save.
Configuring the ANS SMS channel for GSM modem
If you require two-way SMS but require sending very low volume messages, then you can use a
GSM modem with a valid SIM card subscription from a mobile service provider. The GSM
modem connects to the ANS server serial port. The GSM modem simulates the mobile phone to
send and receive SMS messages to and from the service provider.
You can follow the GSM modem installation guide to install the GSM modem to the ANS server
serial port and install the SIM card into the GSM modem.
To configure ANS SMS channel for GSM modem:
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. In the Select the Channel/Component to configure field, click SMS_channel.
The system displays the SMS server details.
3. Set the Connector_Type property to SimServerConnector.
4. Set the IS_TWO_WAY property to True.
5. Set the SMS_ENCODING property to any one of the following options:
●
0 for 7-bit alphabet encoding.
Each SMS message can contain 160 characters.
●
1 for 8-bit data alphabet encoding.
Each SMS message can contain 140 characters.
●
2 for 16-bit UTF-16/UCS-2 alphabet encoding for languages such as Arabic, Chinese,
Korean, Japanese, or Russian.
Each SMS message can contain 70 characters.
6. Click Save.
74
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Channel configurations
Sending SMS through e-mail
Some mobile service providers can support free e-mail to the SMS gateway services. You can
utilize the ANS E-mail channel to send SMS to these mobile phones. For example, if a user has
a Verizon mobile phone number xyz, you can enter the user profile personal e-mail address as
[email protected] and create the E-mail channel message to send SMS to this mobile phone.
Configuring the IBM Sametime server
Note:
Note:
If you have an all-in-1 ANS, you must create 3 Sametime users for ANS to use.
If you have an HA ANS, you must create 6 Sametime users for ANS to use.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. On the Channel Configuration tab, in the Select the Channel/Component to configure
field, click Sametime_IM_channel.
The system displays the IM_Sametime server details.
3. To configure the IM_Sametime server:
●
Select the following property row and click Edit.
The system displays the respective Edit Property dialog box.
Edit the following property values:
- IS_SAMETIME_ENABLED: The system displays this value as True. Ensure that
you do not change this default value.
- R_SAMETIME_BOT_PASSWORD_0: The IM_Sametime BOT password for the
redundant IM_Sametime server 1.
- R_SAMETIME_BOT_SERVERIP_0: The IM_Sametime BOT IP address for the
redundant IM_Sametime server 1.
- R_SAMETIME_BOT_SERVERPORT_0: The IM_Sametime BOT server port for
the redundant IM_Sametime server 1.
- R_SAMETIME_BOT_USERNAME_0: The IM_Sametime BOT user name for the
redundant IM_Sametime server 1.
ANS Installation and Administration guide
July 2012
75
Chapter 6: Administering the ANS system configurations
Note:
Note:
Similarily, you can configure the R_SAMETIME_BOT_PASSWORD_1,
R_SAMETIME_BOT_SERVERIP_1, R_SAMETIME_BOT_SERVERPORT_1,
and R_SAMETIME_BOT_USERNAME_1 fields for the redundant IM_Sametime
server 2. And configure the R_SAMETIME_BOT_PASSWORD_2,
R_SAMETIME_BOT_SERVERIP_2, R_SAMETIME_BOT_SERVERPORT_2,
and R_SAMETIME_BOT_USERNAME_2 fields for the redundant IM_Sametime
server 3.
- SAMETIME_BOT_COUNT: The maximum number of IM_Sametime BOT required
for sending IM_SAMETIME notifications. Ensure that this value is always greater
or equal to 1, or less than or equal to 3. By default, the BOT count is 3.
- SAMETIME_BOT_PASSWORD_0: The IM_Sametime BOT password for the
IM_Sametime server 1.
- SAMETIME_BOT_SERVERIP_0: The IM_Sametime BOT IP address for the
IM_Sametime server 1.
- SAMETIME_BOT_SERVERPORT_0: The IM_Sametime BOT server port for the
IM_Sametime server 1.
- SAMETIME_BOT_USERNAME_0: The IM_Sametime BOT user name for the
IM_Sametime server 1.
Note:
Note:
Similarly, you can configure the Sametime_BOT_Password_1,
Sametime_BOT_ServerIP_1, SAMETIME_BOT_SERVERPORT_1, and
SAMETIME_BOT_USERNAME_1 fields for the IM_Sametime server 2. And
configure the Sametime_BOT_Password_2, Sametime_BOT_ServerIP_2,
SAMETIME_BOT_SERVERPORT_2, and SAMETIME_BOT_USERNAME_2
fields for the IM_Sametime server 3.
4. Click Save.
5. Stop the sms services in both the master server and the client server after configuring the
SMS channel:
/etc/init.d/ANSIMChannel stop
6. Start the sms services in both the master server and the client server after configuring the
SMS channel:
/etc/init.d/ANSIMChannel start
76
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Channel configurations
Configuring XMPP to connect to the Presence Server
Note:
Note:
If you have an all-in-1 ANS, you must create 3 XMPP users for ANS to use.
If you have an HA ANS, you must create 6 XMPP users for ANS to use.
1. In the navigation pane, click System Configuration > Channel Configurations.
The system displays the Channel Configurations page.
2. On the Channel Configuration tab, in the Select the Channel/Component to configure
field, click XMPP_IM_channel.
The system displays the IM_XMPP server details.
3. To configure the IM_XMPP server:
●
Select the following property row and click Edit.
The system displays the respective Edit Property dialog box.
Edit the following property values:
- IS_XMPP_ENABLED: The system displays this value as True. Ensure that you do
not change this default value.
- R_XMPP_BOT_PASSWORD_0: The IM_XMPP BOT password for the redundant
IM_XMPP server 1.
- R_XMPP_BOT_SERVERIP_0: The IM_Sametime BOT IP address for the
redundant IM_Sametime server 1.
- R_XMPP_BOT_SERVERPORT_0: The IM_Sametime BOT server port for the
redundant IM_Sametime server 1.
- R_XMPP_BOT_USERNAME_0: The IM_Sametime BOT user name for the
redundant IM_Sametime server 1.
Note:
Note:
Similarily, you can configure the R_XMPP_BOT_PASSWORD_1,
R_XMPP_BOT_SERVERIP_1, R_XMPP_BOT_SERVERPORT_1, and
R_XMPP_BOT_USERNAME_1 fields for the redundant IM_XMPP server 2. And
configure the R_XMPP_BOT_PASSWORD_2, R_XMPP_BOT_SERVERIP_2,
R_XMPP_BOT_SERVERPORT_2, and R_XMPP_BOT_USERNAME_2 fields
for the redundant IM_XMPP server 3.
- XMPP_BOT_COUNT: The maximum number of IM_XMPP BOT used for sending
IM_XMPP notifications. Ensure that this value is always greater or equal to 1 or
less than or equal to 3. By default the BOT count is 3.
- XMPP_BOT_PASSWORD_0: The IM_XMPP BOT password for the IM_XMPP
server 1.
- XMPP_BOT_SERVERIP_0: The IM_XMPP BOT IP address for the IM_XMPP
server 1.
ANS Installation and Administration guide
July 2012
77
Chapter 6: Administering the ANS system configurations
- XMPP_BOT_SERVERPORT_0: The IM_XMPP BOT server port for the IM_XMPP
server 1.
- XMPP_BOT_USERNAME_0: The IM_Sametime BOT user name for the
IM_XMPP server 1.
Note:
Note:
Similarly, you can configure the XMPP_BOT_Password_1,
XMPP_BOT_ServerIP_1, XMPP_BOT_SERVERPORT_1, and
XMPP_BOT_USERNAME_1 fields for the IM_XMPP server 2. And configure the
XMPP_BOT_Password_2, XMPP_BOT_ServerIP_2,
XMPP_BOT_SERVERPORT_2, and XMPP_BOT_USERNAME_2 fields for the
IM_XMPP server 3.
4. Click Save.
5. Stop the sms services in both the master server and the client server after configuring the
SMS channel:
/etc/init.d/ANSIMChannel stop
6. Start the sms services in both the master server and the client server after configuring the
SMS channel:
/etc/init.d/ANSIMChannel start
Configuring Web services API
To add a trusted host:
1. In the navigation pane, click System Configuration > Security Configuration.
2. Select the Web Services Trusted Servers tab.
The system displays the Trusted Host page.
3. Click Add.
The system displays the Trusted Host dialog box.
4. Enter the following parameters:
●
Host: Enter the IP address that is a host name of the Web services API.
●
Trusted: To make the host trusted, select the Trusted check box.
5. Click Save.
The system displays the Success pop-up window.
6. Click Close.
78
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Trigger configuration
Trigger configuration
In the Trigger configuration section, you can configure the following:
●
Inbound number for Inbound call trigger
●
E-mail trigger mailbox for E-mail call trigger
Adding an inbound phone number
An inbound number is the phone number that IP PBX routes to ANS for triggering the
notification scenarios or retrieving the inbox messages.
As an Administrator, you must create a list of inbound phone numbers as resources for each
partition. This enables the managers in each partition to create the inbound call triggers by
selecting the phone numbers that you have allocated to them.
Note:
Note:
Sometimes, the IP PBX does not send the full DID phone number to ANS. To
ensure that the inbound numbers work, you can run the traceSAS command from
the ANS Linux prompt to capture the SIP INVITE coming from the IP PBX, and
find out the number of digits in the To header. The inbound phone numbers you
configure on ANS must match exactly with the phone number in the To header.
To add an inbound call trigger:
1. In the navigation pane, click System Configuration > Trigger Configuration.
The system displays the Inbound Number page.
2. Click Add.
The system displays the Add Inbound Number Data dialog box.
3. Enter the following parameters:
●
Inbound number: The inbound number that you want to associate with a inbound call
trigger.
●
Partition: In the Partition field, click the partition that you want to assign to the inbound
call trigger.
4. Click Save.
The system displays the Success pop-up window.
5. Click Close.
ANS Installation and Administration guide
July 2012
79
Chapter 6: Administering the ANS system configurations
Adding an e-mail trigger mailbox
An email trigger mailbox is the email account on the Microsoft Exchange server so that email
alarms can be sent to this mailbox and the associated notification scenarios can be triggered in
ANS.
As an Administrator, you must create a list of email trigger mailbox as resources for each
partition. This enables the managers in each partition to create the Email triggers by selecting
the mailboxes that you have allocated to them.
1. In the navigation pane, click System Configuration > Trigger Configuration.
2. Select the Email Trigger Configuration tab.
The system displays the Email Trigger Mailbox page.
3. Click Add.
The system displays the Add Email Mailbox dialog box.
4. Enter the following parameters:
●
Mailbox: The e-mail inbox address that you want to assign to a notification scenario
for an email trigger.
●
User Id: The user ID of the mailbox.
●
Password: The password of the mailbox.
●
Domain: The domain name of the mailbox.
●
Server: The server IP address of the mailbox.
●
Secure: To secure the mailbox, select the Secure check box.
5. Click Save.
Configuring message inboxes
An message inbox is a group level voice message store that allows inbound callers to retrieve
the message. You can store the message in the message inbox either through the inbound call
or through the notification scenarios. If the message inbox is enabled in a notification scenario
voice message, the triggering of that scenario will store the voice message in the associated
message inbox. The inbound caller that retrieves the message from the inbox would be able to
respond to the message and join to the conference call, similiar to the outbound notification
calls.
One typical use case for the message inbox is that the outbound notifications can save the
callback phone numbers in the recipient's voicemail, and allow the recipient to call back to ANS,
get the message, and join the conference.
80
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Trigger configuration
As an administrator, you can create the message inboxes and assign them to each partition as
resources, so that the managers and operators in each partition can select them when creating
the notification scenarios and the inbound call triggers.
Note:
Note:
Each message inbox can store only one message. The previous message will be
overridden by the later message. If the message expires, the system removes the
message from the message inbox automatically.
To add an inbound call trigger:
1. In the navigation pane, click System Configuration > Message Inboxes.
The system displays the Message Inboxes page.
2. Click Add.
The system displays the Add/Edit Message Inbox dialog box.
3. Enter the following parameters:
●
Inbox Number: The unique inbox number to identify the inbox
●
Inbox Description: You can track the groups that use this inbox or the purposes of the
message inbox. You can also put the inbound numbers here as a reminder.
●
Expiration Time: Typically, you might want to increase the default 1 hour expiration to
1 day or more, so that the message can be kept into the inbox for a longer duration.
●
Partition: In the Partition field, click the partition that you want to assign to the
message inbox
4. Click Save.
The system displays the Success pop-up window.
5. Click Close.
ANS Installation and Administration guide
July 2012
81
Chapter 6: Administering the ANS system configurations
82
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Partition
Chapter 7: Administering the ANS user
configurations
The Administering the ANS user configurations section describes the procedure of adding
partitions, users, user profiles, and system settings using the ANS Management Portal.
Partition
Using partition you can manage a set of users in a specific group having different set of
permissions or rules.
Adding a partition
1. In the navigation pane, click System Configuration > Partitions.
The system displays the Partition page.
2. Click Add.
The system displays the Add Partition page.
3. Enter the following parameters:
●
Partition Name: The name of the partition.
●
Max Voice Ports: The maximum number of voice ports required for the partition.
4. Click Save.
The system displays the Success pop-up window.
5. Click Close.
Modifying partition details
1. On the Partition page, select the partition that you want to modify.
2. Click Edit.
The system displays the Edit Partition page.
ANS Installation and Administration guide
July 2012
83
Chapter 7: Administering the ANS user configurations
3. Make the required changes.
4. Click Save.
The system displays the Success pop-up window.
5. Click Close.
Deleting a partition
1. On the Partition page, select the partition you want to delete.
2. Click Delete.
The system displays the Are you sure you want to delete Partition
’<xyz>’ message.
3. Click Yes.
The system displays the Success pop-up window.
4. Click Close.
Configuring LDAP settings
!
Important:
Important:
If you have an HA system, then access both the Web Portals with the physical IP
addresses of both the servers, and perform the following configurations on both
the servers. Make sure that you configure both the servers with the same values.
1. In the navigation pane, click System Configuration > LDAP configuration.
The system displays the LDAP Mappings page.
2. Select the LDAP tab.
The system displays the LDAP parameters page.
3. To configure the LDAP parameters:
Select a LDAP parameter, click Edit, and enter the values for the following LDAP
parameters:
84
●
CRITERIA: The rule that the system uses to search an LDAP user
●
CRITERIA_GROUP: The rule that the system uses to search an LDAP group.
●
CRITICAL: The critical parameter that the system uses for searching in LDAP.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Configuring LDAP settings
●
EXTERNAL_SYNC_COUNT: The number of user records that the sync process
downloads before pausing EXTERNAL_SYNC_INTERVAL.
●
EXTERNAL_SYNC_INTERVAL: The number of seconds for which the sync process
pauses for every EXTERNAL_SYNC_COUNT for downloading user records.
●
INITIAL_CONTEXT_FACTORY: The context factory of LDAP Java Naming and
Directory Interface (JNDI).
●
LDAP_GROUP_DN: The group distinguished name where the system performs the
search.
●
MAIN_SYNC_INTERVAL: The interval in minutes in which the application runs.
●
PAGE_SIZE: The page size used to search on LDAP. Ensure that the value of Page
Size field is great than zero.
●
ADDRESS: The IP address or the host name of LDAP.
●
PORT: The port number of LDAP.
●
SEARCH_SCOPE: The search scope that the system uses in the LDAP connection.
●
SECURITY_AUTHENTICATION: The method of security authentication used in LDAP.
The methods used to authenticate in LDAP are None, Simple, and Strong.
Default is Simple.
●
SECURITY_CREDENTIALS: The security credentials, such as password to
authenticate the LDAP connection.
●
SECURITY_PRINCIPAL: The login ID used in the LDAP connection.
●
TIME_LIMIT_FOR_SEARCH: The timeout for search in LDAP in millisecond.
Default is 300000
●
TIME_OF_EXECUTION: The daily time of execution.
The format is hh24:mm.
●
ENABLE_GROUP_SYNC: To activate group synchronization, enter True.
4. Click Save.
After you delete the LDAP users from the user profile, you can expect the following behavior:
1. If users are deleted manually from the ANS Management Portal, then the next LDAP sync
automatically adds these deleted users.
2. If users are deactivated manually from the ANS Management Portal, then the next LDAP
sync automatically activates these deactivated users if the Active status is not mapped to
the LDAP attribute.
3. If the user profile fields are manually updated from the ANS Management Portal, then the
next LDAP sync automatically overrides the updated user profile fields with the value from
the LDAP attributes
ANS Installation and Administration guide
July 2012
85
Chapter 7: Administering the ANS user configurations
Note:
The system retains the updates in the user profile fields, if these fields are not
mapped with the LDAP attributes.
Note:
4. If you delete the users from the LDAP directory, then the system also deletes these users
from the ANS database.
User management
User management overview
ANS has the following types of users:
●
User: As a user with a given password, you can log into the ANS Management Portal and
only update your personal profile.
●
LDAP user: As an LDAP user with a given password, you can log into the ANS
Management Portal and only update your personal profile.
●
Operator: As an operator, you can perform all the tasks of a user and also the following:
- Create notifications
- Trigger notifications
- Check the notification status
- Send notifications
- Manage my groups
- Manage my escalations
- Manage my scenarios
- Trigger scenarios and check session status
●
Manager: As a manager, you can perform all the tasks of a user, operator and also the
following:
- Manage all users within a partition
- Manage all groups within a partition
- Manage all escalations within a partition
- Manage all scenarios within a partition
- Manage all triggers within a partition
- Create reports
86
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Importing users
●
Administrator: As an administrator, you can perform all the tasks of an user, operator,
manager, and also the following:
- Manage system configuration
- Perform system maintenance
- Create new partitions
- Assign resources to partitions
- Create user defined fields
- Create other administrator and manager role users.
Note:
Note:
For information on adding, modifying, and deleting users, see the User
Management section in the ANS Operating guide.
Importing users
You can import bulk of users using a Comma Separated Values (CSV) file and Lightweight
Directory Access Protocol (LDAP) mappings, instead of manually entering these users.
Importing users using a CSV file
Using the CSV upload feature, the administrator uploads a list of users from a CSV file. The
CSV upload feature works best in large organizations by saving time and effort by creating
users from a CSV file, instead of manually adding these users.
The CSV Upload operation consists of the following steps:
1. Creating or mapping of metadata
The system maps the CSV columns to the User Profile Field.
2. Uploading the actual data into the system from a CSV file.
To add a new template:
1. In the navigation pane, click Users and Groups > CSV Upload.
The system displays the Load CSV into User Profile page.
2. Click Add.
3. Enter the following parameters:
●
*Template Name: The name of the template that you want to upload.
●
Template Description: The details of the template.
ANS Installation and Administration guide
July 2012
87
Chapter 7: Administering the ANS user configurations
●
Select User Profile Field: In the Select User Profile Field field, click the fields that
you want to add in the template.
The system displays a list of fields that are the fields present in the User Profile page.
This page contains both static fields and User Defined Fields.
4. Click Add.
The system adds the selected user profile field in the User Profile Field column and
assigns a CSV field number to the selected user profile field.
Note:
Note:
You can add a user field only once. It is mandatory to add the User ID, First
Name, and Last Name fields in the new template.
5. To move the position of the User Profile field up, click Up. To move the position of the User
Profile field down, click Down.
6. Click Save.
The system displays the Success pop-up window.
7. Click Close.
To upload the template:
1. On the Load CSV into User Profile page, select a template.
2. Click Proceed to Upload.
The system displays the Upload a CSV dialog box.
3. Click Browse.
4. Select the path of the required CSV file.
5. Click Upload.
The system displays the Information message box stating the status of the upload, total
rows present in the file, rows added successfully, rows updated, validation failed records,
and add or edit failed record count.
Importing users using the LDAP mappings
Using the LDAP Mappings feature, you can upload data from an Active Directory service to the
local database. The LDAP Mappings page displays the LDAP attributes and the local database
attributes mapped together.
Note:
Note:
By default, only the administrators can configure the LDAP settings.
To import users through LDAP mapping:
88
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Importing users
1. In the navigation pane, click System Configuration > LDAP Configuration.
The system displays the LDAP Mappings page.
2. Enter the following parameters:
●
User Field: In the User Field field, click a user field.
●
LDAP Field: In the LDAP Field field, click a LDAP field that you need to map with the
selected user field.
You can map a LDAP field with multiple user fields. For example, Mobile, which is a
LDAP field, can be mapped to MobilePhone and SMSAddress which are user fields.
●
Select a partition to map users: In the Select a partition to map users and group
field, select the partition where you want to assign the user or the group for the LDAP
mapping.
If you do not select any partition, then the system adds the LDAP mapping in the
Default partition.
3. Click Add.
The system displays the user field and LDAP field in the User Profile Field Name and
LDAP Field Name columns respectively.
Note:
You must include the User ID and First Name fields from the User Field field. You
can add up to 10 custom LDAP attributes using the custom LDAP property file.
Note:
4. Click Save.
The system displays the Success pop-up window.
5. Click Close.
To add the custom LDAP attributes:
Note:
If you have an HA system, then perform the following procedures on both the
ANS servers.
Note:
●
Add the custom LDAP attribute in the /opt/Avaya/AvayaNotificationSolution/
config/ldapAttributes.properties file.
Using the custom LDAP property file, you can add only up to 10 custom LDAP attributes. If
you add more than 10 custom LDAP attributes, then the system displays the additional
custom LDAP attributes on the ANS Management Portal, but these additional attributes
have no impact.
Note:
Note:
The /opt/Avaya/AvayaNotificationSolution/config/
ldapAttributes.properties file contains the mandatory and custom
attributes of LDAP. The system displays the newly added custom LDAP attributes
in the LDAP field drop-down list box.
ANS Installation and Administration guide
July 2012
89
Chapter 7: Administering the ANS user configurations
●
You must restart the ANS Management Portal and the LDAP service to display the added
custom LDAP attribute on the ANS Management Portal by typing the following commands
on the Linux command line:
stopANSAll.sh
startANSAll.sh
You must map the custom attributes with the ANS parameters. Later, if you comment or remove
the custom attributes from the properties file, then the system displays the message for
removed attributes and prompts to save the mapping.
You must save the mapping, as there could be a possibility where you map the custom
attributes with mandatory fields, and the system does not save the mapping. If the system tries
to save the mapping again, the system raises a validation message. Unless you map the
mandatory fields again, the system does save the mapping.
Authoring role to a user
1. In the navigation pane, click System Configuration > Security Configuration.
2. Select the Role Authorization tab.
The system displays the Role Authorization page.
3. In the Select the Role to authorize field, click User, Operator, LDAP, or Manager. Select
the role that you want to authorize.
The system displays the Function Description table with the followings rows:
90
●
Notification Scenarios
●
My Notification Scenarios
●
Notification History
●
My Notification History
●
Inbound Call Triggers
●
Conference Bridges
●
My Profile
●
Users
●
Groups
●
Escalations
●
My Groups
●
My Escalations
●
CSV Upload
●
Email Trigger Configuration
ANS Installation and Administration guide
Comments? [email protected]
July 2012
User profile settings
●
Usage Reports
4. Select the check box against the Function Description in the following fields:
●
Enable
●
Add
●
Edit
●
Delete
●
View
●
Execute
5. Click Save.
The system displays the Success pop-up window.
6. Click Close.
User profile settings
Adding a user defined field
Using the User Defined Fields page, you can create fields dynamically that can be used for
creating user profile.
Note:
Note:
Only the administrator can add, edit, or delete the user defined fields. You can
add up to 50 user defined fields.
To add user defined field:
1. In the navigation pane, click System Configuration > User Profile Configuration.
The system displays the User Defined Fields page.
2. Click Add.
The system displays the Add User Defined Field dialog box.
3. Enter the following parameters:
●
Label: The label name of the user defined field.
The system automatically populates the added labels in the Filter section on the
Manage User Profile page and in the User Defined Field section on the My Profile
page.
●
Description: The description of the user defined field.
ANS Installation and Administration guide
July 2012
91
Chapter 7: Administering the ANS user configurations
4. Click Save.
The system displays the Success pop-up window.
5. Click Close.
!
WARNING:
WARNING:
You can delete a user defined field only after deleting all its associated mappings
with the CSV parameters.
Modifying the user defined field details
1. On the User Defined Field tab, select the user defined field that you want to modify.
2. Click Edit.
The system displays the Edit User Defined Field page.
3. Make the required changes.
4. Click Save.
The system displays the Success pop-up window.
5. Click Close.
Deleting a user defined field
1. On the User Defined Field tab, select the user defined field you want to delete.
2. Click Remove.
The system displays the Are you sure you want to delete User defined
field ’<xyz>’ message.
3. Click Yes.
The system displays the Success pop-up window.
4. Click Close.
Adding user password settings
1. In the navigation pane, click System Configuration > Security Configuration.
The system displays the User Password Settings page.
2. In the Security Configuration section, select ANS or LDAP option for authenticating the
user in the Authenticate Using field.
92
ANS Installation and Administration guide
Comments? [email protected]
July 2012
User profile settings
3. For the ANS option, enter the following parameters:
●
Minimum Length: The minimum length of the user password.
●
Maximum length: The maximum length of the user password.
●
Can not match Username: If you want to have the user password different from the
user name, select the Can not match Username check box.
●
Requires Digit: To include numeric values in the user password, select the Requires
Digit check box.
●
Requires Punctuation: To include punctuation marks in the user password, select the
Requires Punctuation check box.
●
Requires Alpha: To include alphanumeric values in the user password, select the
Requires Alpha check box.
●
Requires Lower Case Alpha: To include lowercase alphanumeric values in the user
password, select the Requires Lower Case Alpha check box.
●
Requires Upper Case Alpha: To include uppercase alphanumeric values in the user
password, select the Requires Upper Case Alpha check box.
●
Password Expiration (Days): The number of days after which the password is not
valid.
4. For the LDAP option, enter the following parameters:
●
LDAP Server IP: The IP address of the LDAP server.
●
Port: The port number of the LDAP server.
●
User Name: The user name of the LDAP server.
●
Password: The password of the LDAP server.
5. Click Save.
The system displays the Success pop-up window.
6. Click Close.
Configuring a notification rule
1. In the navigation pane, click System Configuration > User Profile Configuration.
The system displays the User Defined Fields page.
2. Select the Default Notification Rule tab.
The system displays the Default Notification Rule page.
3. In the Default Time Zone section, in the Time Zone field, click the time zone that you
want to set as the default time zone for adding users using CSV file or LDAP.
ANS Installation and Administration guide
July 2012
93
Chapter 7: Administering the ANS user configurations
4. In the Default User Contact Rule section, enter the following parameters for the Home
Phone field:
●
Urgent Notifications Rule Time Profile: In the Urgent Notifications Rule Time
Profile field, click from the following options when you want to send notifications to the
home phone in an urgent notification scenario:
- Anytime
- Block
Note:
Note:
If you select Block, then the Urgent Notifications Rule Time Profile Delay(s)
field is unavailable.
- Work Hour 9:00-17:00 M-F
- Extended Hour 7:00 - 19:00 M-F
- Daytime 8:00 - 18:00 M-F
- Evening 18:00 - 22:00 M-F
- Weekdays M-F
- Weekends S-Su
●
Urgent Notifications Rule Time Profile Delay(s): The delay in seconds for an urgent
notification scenario.
●
Normal Notifications Rule Time Profile: In the Urgent Notifications Rule Time
Profile field, click from the following options when you want to send notifications to the
home phone in a normal notification scenario:
- Anytime
- Block
Note:
Note:
If you select Block, then the Normal Notifications Rule Time Profile Delay(s)
field is unavailable.
- Work Hour 9:00-17:00 M-F
- Extended Hour 7:00 - 19:00 M-F
- Daytime 8:00 - 18:00 M-F
- Evening 18:00 - 22:00 M-F
- Weekdays M-F
- Weekends S-Su
●
94
Normal Notifications Rule Time Profile Delay(s): The delay in seconds for a normal
notification scenario.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
User profile settings
5. To enter the parameters for the Mobile Phone, Work Phone, IP Phone Extension, SMS
Address, Personal Email, Work Email, Sametime Address, XMPP Address, and WIFI
Phone fields, repeat Step 4.
6. Click Save.
Configuring file size for attachments
1. In the navigation pane, click System Configuration > Security Configuration.
The system displays the User Password Settings page.
2. Select the File Size Configuration tab.
The system displays the File Size Configuration page.
3. To change the value of the following parameters, select the property field and click Edit:
●
MAX_CSV_FILE_SIZE: The maximum limit for the CSV file in MB.
●
MAX_EMAIL_FILE_SIZE: The maximum limit for the e-mail attachment in MB.
●
MAX_WAV_FILE_SIZE: The maximum limit for the .WAV file in MB.
4. Click Save.
ANS Installation and Administration guide
July 2012
95
Chapter 7: Administering the ANS user configurations
96
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Backing up the ANS database
Chapter 8: Maintaining ANS
Backing up the ANS database
Note:
Run the database backup only when the server is not in use for the notifications,
LDAP sync, CSV upload, or any other database intensive activities.
Note:
This command can support both all-in-one server and HA server database
backups.
Run the following command at each ANS server to manually backup the database:
●
AllInOneBackupDB.sh
●
Enter the folder or accept the default folder.
●
Enter the backup filename, for example, ansdb-nodeA-2012-7-19.backup.
Restoring the ANS database
Note:
Note:
Restore the database only in the server maintenance window because you would
be required to stop the ANS services.
For restoring the HA database, you must perform the database restoration
against both the ANS servers, even though one of the servers may already have
a good database. This ensures that the databases are synchronized after the
restoration.
Restoring the database in an all-in-one server:
1. Stop the ANS services:
stopANS.sh
2. Restore the database:
AllInOneRestoreDB.sh
3. Enter the folder or accept the default folder.
4. Enter the backup filename to restore.
ANS Installation and Administration guide
July 2012
97
Chapter 8: Maintaining ANS
5. If the restoration ends with errors, re-run the following command and then select the same
backup filename:
AllInOneRestoreDB.sh
6. If the restoration fails again, re-run the following command and then select a different
backup filename:
AllInOneRestoreDB.sh
7. If the restoration is successful, start the ANS services:
startANS.sh
Restoring the database and recovering the database sync in HA
servers:
1. Put both node A and node B into HA stopped state with the following command on both
servers:
/opt/Avaya/AvayaNotificationSolution/tmp/haStopANS.sh
2. Set up or select the right database backup file to restore the HA database:
●
●
If you know that one of the HA servers has a good database but the other one is out of
sync, you can back-up the good live database first and use the backed up date to
restore the HA database.
●
Run the following command on the good database server to backup the live
database:
/opt/Avaya/AvayaNotificationSolution/tmp/
ansHABackupLiveMasterDB.sh
●
The system generates the backup file at /var/avaya/ans/ansdb.
Copy this file to the other server at the same place:
scp /var/avaya/ans/ansdb root@other_server_IP:/var/avaya/
ans/ansdb
If both the databases are corrupted, then select an earlier backup file to restore the HA
database, and copy the backup file to both the servers with the filename as
/var/avaya/ans/ansdb.
●
98
For example, if the latest backup file /var/avaya/ans/ansdb in node A is a
good database, then copy the backup file node B.
Note: You can rename the existing /var/avaya/ans/ansdb on node B to
another name before running the following command to avoid the override:
scp /var/avaya/ans/ansdb root@node_B_IP:/var/avaya/ans/ansdb
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Scheduling backup and archive of the ANS database
●
If the earlier date of backup file on node A is what you want, then copy the backup
file to /var/avaya/ans/ansdb first, and then copy the backup file to node B.
Note: You can rename the existing /var/avaya/ans/ansdb on node B to
another name before running the following command to avoid the override:
cp /var/avaya/ans/ansdb-xx-xx-xx /var/avaya/ans/ansdb
scp /var/avaya/ans/ansdb
root@node_B_IP:/var/avaya/ans/ansdb
3. Run the following script to recover the database on both node A and node B:
/opt/Avaya/AvayaNotificationSolution/tmp/ansHARestoreDB.sh
Make sure that you select no when prompted for do you wish to start.
This leaves both the nodes in the HA stopped state after the restoration.
4. Restart the ANS HA services on both the nodes.
●
Run the following script on node A first, and then wait for five seconds. Then run the
same script on node B. This ensures that node A get the virtual IP and become the
master node:
/opt/Avaya/AvayaNotificationSolution/tmp/haStartANS.sh
5. Check the ANS status on both the servers with the following command:
ANSStatus.sh
Note: Ignore the last failure item on TTS wav file creations.
6. Verify that the server is installed successfully:
●
Browse to the ANS Web Portal https://xxx.xxx.xxx.xxx:8443/ANSWebPortal.
Replace xxx.xxx.xxx.xxx with the virtual IP address.
●
Log in as admin with the existing password.
●
Make sure that both the channels from both the ANS servers are active under the
Channel Status page.
Scheduling backup and archive of the ANS database
You can schedule daily auto backup of the ANS database and archiving of the notifications
using the ANS backup and archive tool application. You can access this application using a
Web console or VNC.
You can schedule daily auto backup of the ANS database and archiving of the notification
session histories using the ANS backup and archive tool. You can access this tool by using the
server GUI console or by using VNC.
To schedule backup and archive:
1. Log in to Linux as root.
ANS Installation and Administration guide
July 2012
99
Chapter 8: Maintaining ANS
2. Double-click the ANS backup and archive tool icon.
The system displays the ANS backup and Archive tool screen.
3. On the Settings tab, enter the following parameters:
●
In the Job Settings section:
- The time when you want to schedule the backup and archive in the Hour (0-23)
and Minutes (0-59) fields.
- Administrator's Email: The e-mail address of the administrator for sending the
backup and archive status notification e-mails.
●
In the Backup Settings section:
- No. of backups to be preserved: The number of days for which you need the
ANS database backup. Therefore, you can restore the ANS database to the
respective date.
The system saves the back-up file in the MMDDYYYhhmm.backup file format.
- Backup Directory: Click Browse and specify the path where you want to save the
backup files for the ANS database.
●
In the Archive Settings section:
- No. of months (Active data): The number of months for which you want to
archive the current ANS data, such as notifications.
- Archive Directory: Click Browse and specify the path where you want to save the
current ANS data.
●
Click Apply.
4. On the Restore DB tab:
!
Important:
Important:
Please do not use this Restoring DB function. Follow the procedure for
Restoring the ANS database on page 97.
5. On the View Archive tab:
●
Archive file: Click Browse and specify the folder where the archived file is saved.
●
To view the details of a archived file:
- Select an archive file.
- Click View.
100
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Maintaining/Viewing the driver channel status
Note:
Note:
If you do not have access to the GUI console or VNC, you can also configure the
ANS backup and archive settings in the /opt/Avaya/
AvayaNotificationSolution/ANSBackupArchive/config/
ansBackupArchive.conf property file.
You also need to change the /opt/Avaya/AvayaNotificationSolution/
ANSBackupArchive/config/ANSBackupArchive.crontab property file:
cat /opt/Avaya/AvayaNotificationSolution/ANSBackupArchive/
config/ANSBackupArchive.crontab
The system displays an output similiar to the following:
30
1
*
*
*
sh /opt/Avaya/
AvayaNotificationSolution/ANSBackupArchive/scripts/
ANSBackupArchive.sh performjob
The first number in this example is the scheduled minutes, and the second
number is the scheduled hours. The example means that the backup will start at
01:30A.M. every day.
After you make the changes to the file, run the following script to start the
scheduling:
cd /opt/Avaya/AvayaNotificationSolution/ANSBackupArchive/
scripts./updatecronjob.sh
Maintaining/Viewing the driver channel status
1. In the navigation pane, click System Maintenance > Channel Status.
The system displays the Channel Status page.
2. The Channel Status page consists of the driver channel status details displayed in a
tabulated format with the following columns:
●
Note:
Channel
Note:
If a channel is not displayed in the driver channel status list, then that channel is
either not running or unavailable in the ANS package.
●
Present status
●
IP Address
ANS Installation and Administration guide
July 2012
101
Chapter 8: Maintaining ANS
Maintaining the registered IP Phones
You must register an IP Phone to the ANS Management Portal to send notification message
successfully to the IP Phone. You can view the details of these registered IP phones on the
Registered IP Phone Extensions page.
1. In the navigation pane, click System Maintenance > Registered IP Phones.
The system displays the Registered IP Phone Extensions page.
2. The Registered IP Phone Extensions page consists the registered IP Phone details
displayed in a tabulated format with the following columns:
●
Extension: Displays the extension number of the IP Phone that is registered to the
ANS Management Portal.
●
IP Address: Displays the IP address of the registered IP Phone.
●
Machine Address (MAC): Displays the machine address of the registered IP Phone.
●
Set ID: Displays the model number of the registered IP Phone.
3. To display the latest registered IP Phones, click Refresh.
Deleting a registered IP Phone
1. On the Registered IP Phone Extensions page, select a registered IP Phone.
2. Click Delete.
The system displays the Do you want to delete extension <xyz> message.
3. Click Yes.
The system displays the Success pop-up window.
4. Click Close.
Maintaining Resource Manager status
The Resource Status table displays a dynamic view of the resource capacities and current
resource usage, such as:
102
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Maintaining Resource Manager status
●
Licensing: There are two resources in the Resource Status table that handles licensing,
that is ANS voice notification channel ports and ANS Media Server ports. The system
takes the capacity for these two resources from the ANS license file. Using Resource
Manager, you can enforce capacity as you send notifications. These resources limit the
number of simultaneous notifications and the number of simultaneous conference ports.
You can change the capacity of these resources after you obtain and install a new ANS
license from Avaya.
●
Capacity: Capacity for various system resources, such as Voice ports, Media Server
Ports, and so on. Capacity of these various system resources is limited depending on the
engineered capacity of the system. You cannot change the capacity value for these
system resources.
●
Partitions: Partitions include a limit on the number of simultaneous voice ports that a
given partition uses. You can change this limit from the Partition configuration page. For
details, see the Adding a partition on page 83 section.
●
Trunks: The trunk resource limit is set based on the trunk capacity configured in the
remote trunk termination. You can set the Trunk resource limits, that are number of
simultaneous channels in use, on the trunk configuration page. For details, see the
Configuring SIP Trunks on page 51 section.
Maintaining resource status
1. In the navigation pane, click System Maintenance > Resource Manager Status.
The system displays the Resource Status page.
2. The Resource Status page shows the managed resources, including SIP trunks, Media
Servers, partitions, and ANS licenses in a tabulated format with the following columns:
●
Resource Name: The name of the resource added on the ANS Management Portal.
For SIP trunk, if the value for the MX port Count, PSTN Prefix, or Extension Port
Count fields is non-zero, then the system displays this SIP trunk entry as follows:
- SIPTRUNK-MX
- SIPTRUNK-PSTN
- SIPTRUNK-EXTENSION
●
IP Address: The IP address of the resource. For example, IP address of the SIP trunk
or Media Server.
●
Priority: The priority of the resource.
●
Capacity: The maximum port count of the resources.
●
Allocated Ports: The number of allocated ports for the resource.
●
Failed Ports: The number of failed ports for the resource.
ANS Installation and Administration guide
July 2012
103
Chapter 8: Maintaining ANS
●
Operational Status: The operation status of the resource, whether the status is UP or
DOWN.
Maintaining resource assignment
The Resource Assignment page displays the resources that are:
●
currently assigned and are in use
●
lost
The Resource Assignment page does not display a resource that has idle status.
To view the resource assignment:
1. In the navigation pane, click System Maintenance > Resource Manager Status.
The system displays the Resource Status page.
2. Select the Resource Assignment tab.
The system displays the Resource Assignment page.
3. The Resource Assignment page consists of the resource assignment details in a
tabulated format with the following columns:
●
Resource Name: Name of the allocated resource.
●
Resource Assignment: The universally unique identifier (UUID) of the particular
assignment.
●
Leased To: The name of the component that requests for the resource. For example,
voice channel driver.
●
Lease Start Date: The day and time when you had initially requested for the resource.
●
Assigned Ports: Number of ports initially allocated to the requestor.
●
InUse Ports: Number of ports that are not released by the requestor.
Maintaining resource manager registration
1. In the navigation pane, click System Maintenance > Resource Manager Status.
The system displays the Resource Status page.
2. Select the Resource Manager Registration tab.
The system displays the Resource Manager Registration page.
3. The Resource Manager Registration page consists of the resource manager registration
details. These details are displayed in a tabulated format with the following columns:
●
104
Resource Manager Registration: Specifies the host for the Resource Manager.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
ANS Recovery Manager and Watchdog service overview
●
Is Alive: Specifies whether the Resource Manager is registered. In general, the value
of Is Alive is Yes.
●
Is Master: Specifies whether the Resource Manager is currently the active Resource
Manager for the ANS cluster.
ANS Recovery Manager and Watchdog service overview
Recovery Manager
You can use the Watchdog service to monitor important ANS services, such as Web Server,
database, coordinator, Resource Manager, SIPAS, Media Server, TTW, and the channel
drivers. If the Watchdog service detects any failures for the ANS services, the Watchdog service
restarts the failed ANS services. If the failed ANS services do not restart with 3 retries, then the
Watchdog service restarts the heartbeat service that results in the virtual IP to switch.
The Watchdog service does not monitor LDAP and Wi-Fi phone driver as the system needs to
keep one LDAP and one Wi-Fi phone driver down in one server to avoid conflict.
The watchdog service is a part of the stopANSAll.sh and startANSAll.sh commands.
The watchdog service checks the SIPAS ServiceHost0 or the var directory, and removes
the available dump files.
Downloading the ANS logs
Note:
Note:
If you are using Internet Explorer 7 as your browser, then change the following
settings before performing the tasks for downloading logs.
Click Tools > Internet Options > Advanced.
In the Security section, select the Do not save encrypted pages to disk
checkbox.
1. In the navigation pane, click System Maintenance > Download ANS logs.
The system displays the Download ANS Logs page.
2. To download logs for an ANS component:
●
Select an ANS component.
●
Select the check box next to the ANS component.
ANS Installation and Administration guide
July 2012
105
Chapter 8: Maintaining ANS
●
Click Save and save the logs to an appropriate path.
Restarting the ANS services
1. Log in to Linux as root.
2. Run the following commands:
●
stopANS.sh
●
startANS.sh
3. To check the status of the ANS service, go to the /opt/Avaya/AvayaNotificationSolution
folder.
4. Type the following command:
ANSStatus.sh
Note:
Note:
Ignore the failure on the "Loquendo WAV file created in last 24 hours?".
The system specifies that the ANS service has started.
Running the SIP call trace
1. Log in to Linux shell as root.
2. To install traceSAS that is bundled with the ANS package, run the traceSAS command.
The system displays the call traces between various entities configured on the ANS server
and the ANS server. For example, the entities configured on the ANS server are Avaya
Media Server, CS1000, and so on.
3. Make sure to exit the trace before disconnecting from the system.
106
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Chapter 9: Quick troubleshooting tips
This section provides some useful links and commands for troubleshooting ANS 2.0
implementation.
●
Check to see channel status:
From the main menu, go to System Maintenance> Channel Status.
●
Check SIP Trunks and Media Servers status:
From the main menu, go to System Maintenance> Resource Manager Status.
●
Check IP Phone registration status:
From the main menu, go to System Maintenance> Registered IP Phone Extensions.
●
Check ANS services status:
/opt/Avaya/AvayaNotificationSolution/ANSStatus.sh
Note:
Ignore the failure on the "Loquendo WAV file created in last 24 hours?".
Note:
●
Stop All ANS services:
/opt/Avaya/AvayaNotificationSolution/stopANS.sh
●
Start All ANS services:
/opt/Avaya/AvayaNotificationSolution/startANS.sh
●
Start the SIP call trace:
/opt/Avaya/AvayaNotificationSolution/traceSAS
ANS Installation and Administration guide
July 2012
107
Chapter 9: Quick troubleshooting tips
108
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix A: Port specifications
The following table describes the various ports used by ANS:
ANS
Compon
ents
Port
number
Type
Protocol
Purpose
Jboss
node 1
8080
TCP
HTTP
Manage
ment
Portal, IP
Phone
Channel.
X
Jboss
node 1
8443
TCP
HTTPS
Manage
ment
Portal
X
Jboss
node 2
8180
TCP
HTTP
Web
Services
X
Jboss
node 2
8543
TCP
HTTPS
Web
Services
X
Tomcat
18080
TCP
HTTP
WebLM
licensing
X
X
Tomcat
52233
TCP
HTTPS
WebLM
licensing
X
X
AMS EM
8090
TCP
HTTP
AMS EM
portal
X
AMS EM
9443
TCP
HTTPS
AMS EM
portal
X
ANS
Database
5432
TCP
PostgreS
QL
database
X
AMS
Database
3306
TCP
MySQL
database
X
LDAP
Database
1528
TCP
Derby
database
X
RM
Database
1527
TCP
Derby
database
X
ANS Installation and Administration guide
Within
ANS
Cluster
From
ANS to
External
From
External
to ANS
July 2012
109
Appendix A: Port specifications
110
ANS
Compon
ents
Port
number
Type
Symmetri
cDS
8010
TCP
Coordinat
or
1235
TCP
JGroup
45566
JGroup
Protocol
Purpose
Within
ANS
Cluster
Database
Sync
X
RMI
Coordinat
or
X
UDP
JGroup
Coordinat
or and
Channel
Drivers
X
45599
UDP
JGroup
Resource
Manager
X
JGroup
5556
TCP
TCPGOS
SIP
Communi
cation
Bus
TTW
1236
TCP
RMI
RMI
access to
TTW
X
TTW
8088
TCP
HTTP
TTW
HTTP
service
X
Voice
Channel
5070
TCP
SIP
SIP
Trunks
Voice
Channel
5060
TCP
SIP
SIP
Trunks
X
Voice
Channel
5060
TCP
SIP
SIP to
Avaya
Meeting
Exchang
e
X
Voice
Channel
1239
TCP
HTTP
Voice
recording
X
Voice
Channel
9090
TCP
HTTP
HTTP
dialer API
X
Media
Server
14000-32
598
UDP
RTP
Inbound
RTP/
RTCP
Media
Server
Various
UDP
RTP
Outboun
d RTP/
RTCP
ANS Installation and Administration guide
From
ANS to
External
From
External
to ANS
X
X
X
X
Comments? [email protected]
July 2012
ANS
Compon
ents
Port
number
Type
Protocol
Purpose
Within
ANS
Cluster
From
ANS to
External
Media
Server
5090
TCP
SIP
SIP msml
comman
ds
X
X
IP Phone
Channel
80
TCP
HTTP
ANS to IP
Phone for
text and
audio
push.
X
IP Phone
Channel
Various
UDP
RTP
ANS to IP
Phone for
the audio
steaming.
X
SMS
(Clickatell
option
only)
80
TCP
HTTP
SMS to
Clickatell
service
X
SMS
(SMPP
option
only)
2775
TCP
SMPP
SMPP to
SMS
gateway
X
Email
SMTP
25
TCP
SMTP
Email to
SMTP
Server
X
Email
Trigger
443
TCP
HTTPS
Check
email on
the
Exchang
e server
X
IM XMPP
5222
TCP
XMPP
IM to
XMPP
Server
X
IM
Sametim
e
1533
TCP
TCP
IM to
Sametim
e Server
X
LDAP
389
TCP
LDAP
Sync
users
from
LDAP
X
LDAP
636
TCP
LDAPS
Web
Authentic
ation
X
ANS Installation and Administration guide
From
External
to ANS
X
July 2012
111
Appendix A: Port specifications
ANS
Compon
ents
Port
number
Type
Linux
Heartbea
t
695
UDP
Rsync
873
TCP
Recovery
Manager
112
Protocol
Purpose
Within
ANS
Cluster
Linux
Heartbea
t
X
Rsync
File sync
X
ICMP
Ping SIP
trunk for
health
check
X
X
Recovery
Manager
161 and
162
TCP
SNMP
SNMP
traps
Linux
Shell
22
TCP
SSH
Remote
access
ANS Installation and Administration guide
From
ANS to
External
Comments? [email protected]
From
External
to ANS
X
July 2012
Appendix B: System specifications
The Avaya Notification Solution (ANS) is a software solution and is supported on Red Hat
Enterprise Linux (RHEL). ANS also supports Virtual Machine (VM) technology.
Minimum Support Server Specifications
●
32-bit Redhat Enterprise Linux version 5.4, 5.5, 5.6, or 5.7.
●
8 cores (or 2 quad cores) with Intel or AMD 2.8Ghz CPU.
●
8 GB RAM.
Avaya recommends that you use 12 GB RAM for high performance and high capacity.
●
120 GB storage.
For a High Availability configuration, two servers are required.
System capacities
●
600 Voice Ports.
●
1200 Internal Conference Ports.
●
25,000 user addresses per notification session.
PBX and Communications
●
Avaya Aura® Communication Manager 5 and later.
●
Avaya Communication Server 1000 5.5 and later.
●
Avaya IP Office Release 6 and later.
●
Avaya Aura® Session Manager.*
●
Avaya Aura® Session Border Controller.*
* Optional
Internet Web Browsers
●
Microsoft Internet Explorer (IE) version 7 and 8.
●
Mozilla Firefox.
●
Google Chrome.
Optional Components
●
Directory Servers
- LDAP version 3 (Microsoft Active Directory and OpenLDAP).
●
IP Devices
- Avaya 4600 and 9600 series IP Deskphones.
ANS Installation and Administration guide
July 2012
113
Appendix B: System specifications
- Avaya 1100 and 1200 series IP Deskphones (UNIStim).
●
Instant Messaging
- IBM Lotus Sametime Connect 8.5 and later.
- Openfire 3.6 and later.
●
SMS
- Short Message Peer-to-Peer (SMPP) 3.4.
- Multi-Tech MultiModem GPRS MTCBA-G-F4 Wireless cellular modem.
- Clickatell - Communications Provider, Bulk Messaging Services.
●
Outbound E-mail
- Simple Mail Transfer Protocol (SMTP).
●
Inbound E-mail Trigger
- Microsoft Exchange 2007 and later.
●
Speakers/Horns
- Cyberdata Speakers/Horns.
- Atlas Sound Speakers/Horns.
- Any PA systems that are integrated with IP-PBX.
●
External Audio Conference Bridge
- Avaya Meeting Exchange 5.2 SP1 and later.
- Avaya Aura Conference 7 and later.
- Generic Conference Bridges.
114
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix C: ANS Service Scripts Mapping
Table
startANS.s
h
stopANS.sh
ANSStatus.
sh
Watchdog
restart
trigger
Virtual IP
switch
ANSDefaultN
ode
yes
yes
yes
yes
yes
ANSNode1
yes
yes
yes
yes
yes
ANSNode2
yes
yes
yes
yes
yes
ANSEmailCh
annelService
yes
yes
yes
yes
no
ANSIMChann
elService
yes
yes
yes
yes
no
ANSManage
mentPortal
indirect
indirect
yes
only if node1
stopped
no
ANSSMSCha
nnelService
yes
yes
yes
yes
no
TTWService
yes
yes
yes
yes
no
TTWPort
indirect
indirect
yes
yes
no
ANSVoiceCh
annelSAR
indirect
indirect
yes
no
no
DiskSpace
no
no
yes
no
no
LinuxHeartbe
at
no
no
yes
yes
no
RsyncService
yes
yes
no
AMSCompon
ents
no
no
yes
no
no
PostgreSQLS
ervice
yes
no
yes
yes
yes
ANS Installation and Administration guide
July 2012
115
Appendix C: ANS Service Scripts Mapping Table
116
startANS.s
h
stopANS.sh
ANSStatus.
sh
Watchdog
restart
trigger
Virtual IP
switch
PostgresData
indirect
no
yes
yes
yes
SymmetricDS
yes
no (leave up
if on?)
yes
yes
no
LoquendoLic
ense
no (not a
service)
no (not a
service)
yes
no
no
SIPFSConfig
uration
no (not a
service)
no (not a
service)
yes
no
no
SIPFSPorts
indirect
indirect
yes
yes
no
SIPFSServic
e
yes
yes
yes
yes
no
ANSLicense
yes
(WebLM)
yes
(WebLM)
yes
yes
no
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix D: Enabling port 80 and port 443
To enable port 80:
Add the connector as follows in the server.xml file:
/opt/Avaya/jboss-6.1.0/server/node1/deploy/jbossweb.sar/server.xml:
<Connector protocol="HTTP/1.1" port="80" address="${jboss.bind.address}"
redirectPort="${jboss.web.https.port}" />
To enable 443:
Add the connector as follows in the server.xml file: :
/opt/Avaya/jboss-6.1.0/server/node1/deploy/jbossweb.sar/server.xml:
<Connector protocol="HTTP/1.1" SSLEnabled="true"
port="443" address="${jboss.bind.address}"
scheme="https" secure="true" clientAuth="false"
keystoreFile="${jboss.server.home.dir}/conf/default.jks"
ciphers="SSL_RSA_WITH_RC4_128_MD5,SSL_RSA_WITH_RC4_128_SHA,SSL_D
HE_RSA_WITH_3DES_EDE_CBC_SHA"
keystorePass="jZGbCrwhT7qhRyWr" sslProtocol="SSLv3" />
ANS Installation and Administration guide
July 2012
117
Appendix D: Enabling port 80 and port 443
118
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix E: Updating the certificate for the
Web portal
Note:
Note:
Perform the procedure on both the ANS servers if you have an HA setup.
1. Place the new certificate file at:
/opt/Avaya/jboss-6.1.0/server/node1/conf
2. Back-up original configuration:
cp /opt/Avaya/jboss-6.1.0/server/node1/deploy/jbossweb.sar/
server.xml /opt/Avaya/jboss-6.1.0/server/node1/deploy/
jbossweb.sar/server.xml.backup
3. Edit the following file:
/opt/Avaya/jboss-6.1.0/server/node1/deploy/jbossweb.sar/server.xml
On line 28:
<Connector protocol="HTTP/1.1" SSLEnabled="true"
port="${jboss.web.https.port}"address="${jboss.bind.address}"
scheme="https" secure="true" clientAuth="false"
keystoreFile="${jboss.server.home.dir}/conf/default.jks"
ciphers="SSL_RSA_WITH_RC4_128_MD5,SSL_RSA_WITH_RC4_128_SHA,SS
L_DHE_RSA_WITH_3DES_EDE_CBC_SHA"
keystorePass="jZGbCrwhT7qhRyWr" sslProtocol="SSLv3"/>
Change the highlighted fields to match your new certificate:
For example:
<Connector protocol="HTTP/1.1" SSLEnabled="true"
port="${jboss.web.https.port}"address="${jboss.bind.address}"
scheme="https" secure="true" clientAuth="false"
keystoreFile="${jboss.server.home.dir}/conf/my.p12"
ciphers="SSL_RSA_WITH_RC4_128_MD5,SSL_RSA_WITH_RC4_128_SHA,SS
L_DHE_RSA_WITH_3DES_EDE_CBC_SHA"
keystorePass="myPass" sslProtocol="SSLv3"
keystoreType="PKCS12"/>
Note:
Note:
The following file formats are supported:
JKS, PKCS11 & PKCS12.
If for the PKCS11 and PKCS12 type, you need to add keystoreType="PKCS11" or
keystoreType="PKCS12"
ANS Installation and Administration guide
July 2012
119
Appendix E: Updating the certificate for the Web portal
4. Restart jboss node1 service:
/etc/init.d/ANSJbossNode1 restart
120
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix F: Clickatell status codes
These are message statuses that are generated after the Clickatell gateway has accepted the
message for delivery. Data regarding messages passing initial validation and accepted for
delivery will be included in your Clickatell Central reports.
Number
Hex
Description
Detail
001
0x001
Message unknown
The message ID is
incorrect or reporting is
delayed.
002
0x002
Message queued
The message could not
be delivered and has
been queued for
attempted redelivery.
003
0x003
Delivered to gateway
Delivered to the
upstream gateway or
network (delivered to
the recipient).
004
0x004
Received by recipient
Confirmation of receipt
on the handset of the
recipient.
005
0x005
Error with message
There was an error with
the message, probably
caused by the content
of the message itself.
006
0x006
User cancelled
message delivery
The message was
terminated by a user
(stop message
command) or by our
staff.
007
0x007
Error delivering
message
An error occurred
delivering the message
to the handset.
008
0x008
OK
Message received by
gateway.
ANS Installation and Administration guide
July 2012
121
Appendix F: Clickatell status codes
122
Number
Hex
Description
Detail
009
0x009
Routing error
The routing gateway or
network has had an
error routing the
message.
010
0x00A
Message expired
Message has expired
before we were able to
deliver it to the
upstream gateway. No
charge applies.
011
0x00B
Message queued for
later delivery
Message has been
queued at the gateway
for delivery at a later
time (delayed delivery).
012
0x00C
Out of credit
The message cannot
be delivered due to a
lack of funds in your
account. Please
re-purchase credits.
014
0x00E
Maximum MT limit
exceeded
The allowable amount
for MT messaging has
been exceeded.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix G: SNMP configuration
To configure ANS for sending the SNMP traps to your network monitoring systems, run the
following commands:
/opt/spirit/scripts/configureNMS.sh<ip address>162
service spiritAgent stop
service spiritAgent start
where ip address is the IP address of the NMS client that listens to the SNMP traps. 162 is the
port number for sending the SNMP traps.
For example, the actual command looks as follows:
/opt/spirit/scripts/configureNMS.sh 135.12.268.8 162
ANS Installation and Administration guide
July 2012
123
Appendix G: SNMP configuration
124
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix H: Configuring Audio Codec and
RTP ports
1. Open a Web browser and enter the following URL for the AMS Element Manager Web
Portal: https://xxx.xxx.xxx.xxx:9443
Replace xxx.xxx.xxx.xxx with the AMS server IP address.
2. Login using the root or Linux user that is in the root group.
3. From the Home page, go to Home > System Configuration > Media Processing >
Audio Codecs.
You can change the sequence of Codec priority list which affects the voice call codec
negotiations.
The default sequence is: G.711-ULAN, G.711-ALAW, G.729.
Note:
Note:
Avaya recommends that you disable the G.729 Annex-B option to ensure more
accurate answer machine detections.
4. From the Home page, go to Home > System Configuration > Media Processing >
Advanced Settings. Then click on the Conferencing tab.
You can change the audio RTP range for the following two settings: Starting Port for
Conferencing and Last Port for Conferencing.
The default RTP port range is: 14000 - 32598.
5. If the DTMF did not work when integrating with some special SIP trunks, you might need to
set the RFC2833 type in AMS that matches the received type in the SDP. You can use the
traceSAS command to check which RFC2833 type do not match the 200 OK message
received from the external SIP trunk, and then configure the AMS to match the RFC2833
type.
To configure the RFC2833 type, go to Home > System Configuration > Media
Processing > Digit Relay (DTMF). Select the Specify Type radio button, and then enter
the type number such as 101. Click on the Save button to apply the configuration
changes.
For more information, see the Implementing and Administering Avaya Media Server 7_5
document from the Avaya Media Server documentation section in the Avaya Support site.
ANS Installation and Administration guide
July 2012
125
Appendix H: Configuring Audio Codec and RTP ports
126
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Appendix I: Configuring the system voice
prompts with or without
Loquendo Text To Speech
Note:
Perform the changes on both the ANS servers if you have an HA setup.
Note:
Note:
●
If you want to use Loquendo TTS for the system prompt but want to modify the wordings,
you can edit the /opt/Avaya/SIPAS/8.0.50/ServiceHost0/var/
VoicePrompts_en_US.properties file for the US English locale.
●
If you want to enable system prompts for other TTS locales, you must copy the /opt/Avaya/
SIPAS/8.0.50/ServiceHost0/var/VoicePrompts_en_US.properties file to the other TTS
locale file.
For example, for the France French, you can copy the file as /opt/Avaya/SIPAS/8.0.50/
ServiceHost0/var/VoicePrompts_fr_FR.properties. Then you must edit the file and
translate the English text prompt to French text prompt.
For example, you can translate the following:
vcd.inparams.prompt.repeat.question=Press 0 to hear message again
to
vcd.inparams.prompt.repeat.question=Appuyez sur 0 pour entendre le message de
nouveau
●
If you do not have a valid Loquendo TTS license, then you must configure the system to
use static wav files for the system prompts. You can also replace these static wav files
with your own recorded wav files.
Note:
For the notification scenario voice channel and IP phone audio messages, make
sure that you do not use the text to speech, and only use the recorded messages.
1. Copy the property file.
●
cp /opt/Avaya/SIPAS/8.0.50/ServiceHost0/var/
VoicePromptsPath_en_US.properties.backup /opt/Avaya/SIPAS/
8.0.50/ServiceHost0/var/VoicePromptsPath_en_US.properties
2. The existence of the /opt/Avaya/SIPAS/8.0.50/ServiceHost0/var/
VoicePromptsPath_en_US.properties file enables the voice channel driver to use the
static wav files in the /opt/aps/notify/VoiceSystemPrompts folder when US English
locale is selected in the scenario voice message. You can also replace the default wav
files to your own recorded wav files by editing the
VoicePromptsPath_en_US.properties file.
ANS Installation and Administration guide
July 2012
127
Appendix I: Configuring the system voice prompts with or without Loquendo Text To Speech
3. If you want to enable other language prompts using the recording wav files, for
example the France French, then perform the following tasks:
Note:
Note:
128
●
cp /opt/Avaya/SIPAS/8.0.50/ServiceHost0/var/
VoicePromptsPath_en_US.properties.backup /opt/Avaya/SIPAS/
8.0.50/ServiceHost0/var/VoicePromptsPath_fr_FR.properties
●
Then save all the French system prompt wav files in a folder and edit the
VoicePromptsPath_fr_FR.properties file to use the right wav files.
Note:
You must restart the voice channel driver for the changes to take effect.
●
/etc/init.d/ServiceHost0 stop
●
/etc/init.d/ServiceHost0 start
Note:
If you made any changes in the voice prompt files, then keep a backup copy of
the changed files in a backup folder so that you can restore these settings if you
have to re-install the ANS in the future.
ANS Installation and Administration guide
Comments? [email protected]
July 2012
Index
A
ANS
Basic Features . . . . . . . . . . . . . . . . . . 11
Overview . . . . . . . . . . . . . . . . . . . . 9
C
Creating a clickatell account . . . . . . . . . . . . . 72
E
Edit property of a channel . . . . . . . . . . . . . . 69
T
Troubleshooting . . . . . . . . . . . . . . . . . . 107
Installing and administering ANS
July 2012
129
Index
130
Installing and administering ANS
Comments? [email protected]
July 2012
">