Overview
This topic describes how to use the PC-based Administration
and Data Acquisition Package (ADAP) that allows voice mail customers
to transfer data such as download traffic data, subscriber data, and
other system data from a voice mail system to the PC for further processing.
Customers can also use ADAP to modify data directly in the voice mail
system subscriber database.
ADAP works with the following AUDIX systems:
INTUITY AUDIX: 2.0, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, or 4.4, 5.0, 5.1.
INTUITY AUDIX LX Release 1, and Avaya S8300 Media Server.
ADAP allows you to work with data from
the voice mail database:
- The command line language allows programmers to
download data from the voice mail system to the PC for use in customer-developed
applications. By using the command line language programmers can also
modify subscriber data in the voice mail system.
The information in this topic is intended
for:
- Programmers who use the ADAP command line language
to:
- Retrieve data from the voice mail system to the
PC for use in customized applications
- Modify subscriber records directly in the voice
mail database
Programmers who use the ADAP command line
language to write application programs should have a working knowledge of
the PC, the MS-DOS operating system, and the INTUITY AUDIX, administration
interface.
ProVision is an optional tool that you can use to perform
bulk subscriber administration for INTUITY AUDIX LX R1. ProVision communicates
with INTUITY AUDIX LX R1 using the ADAP interface. For information on
using ProVision, see the ProVision documentation.
Conventions Used
The following conventions are used throughout
the ADAP topics:
|
Bold
|
Command names and options to be entered exactly
as they are shown.
Example: For the command line getdir [-v] [>
ofile] enter getdir and (optionally) -v.
|
|
Italics
|
Variables to be replaced with literal values.
Example: For > ofile (shown in the previous
example), enter the name of the output file to receive the data.
|
|
Brackets
|
Optional arguments
Example: For [v], entering v is optional.
|
|
|
Each command option consists of a dash, followed
immediately by a one-letter option identifier. For an identifier that
requires an argument, you can insert a space between the identifier
and the argument for readability, but the space isn't required.
|
|
<RETURN>
|
The name of a key that you press.
|
How ADAP Works
The PC from which you run ADAP is connected
to your voice mail system by either a direct or dial-up connection. If you
are using the ADAP command line language, you log into the voice mail system
from your PC and access the voice mail database using an ADAP-supplied login
command.
ADAP does not work directly with live
data in the voice mail database, except for database modification commands
and the system attendant reports. Live data is the information maintained
by the voice mail system and stored on the system itself. ADAP retrieves
a copy of this data for storage on the PC. When you change the retrieved
that is data stored on your PC your action does not change the data stored
on the voice mail system.
With the command line language, you can
display the data on your PC screen, direct it to a printer, or direct it
to a file for further processing. If you retrieve data to a file, you can
develop your own programs to manipulate the data or port the data to a mainframe
for further processing.
ADAP Data Retrieval
Data can be retrieved in the following
ways:
- You can write application programs
that use ADAP command line language commands to retrieve database information
to your PC.
- You can enter individual ADAP
command line language commands from the keyboard of the PC at the MS-DOS
prompt to retrieve data to the PC in a flat ASCII format.
- You can execute ADAP command
line language commands from an MS-DOS batch file.
You can use retrieved data to:
- Bill voice mail system users,
either on a space, call, or time basis.
- Analyze daily, hourly, or monthly
traffic information for local and network traffic, and monthly traffic
information for system attendant traffic.
- Analyze subscriber usage.
- Analyze AUDIX system call detail
recording (CDR) data and AUDIX system performance statistics.
- Produce reports to support
a wide range of decisions — from administrative decisions, such
as changing the amount of time an individual subscriber retains a message,
to management decisions, such as expanding the voice mail system to
include more ports. For example, you can determine actual system use
and compare it with the type of use that was initially forecast for
your site when your system was configured.
ADAP Database Modification
You can use database modification commands
to:
- Add new local and remote subscriber
records to the voice mail database.
- Delete existing local and remote
subscriber records from the voice mail database.
- Modify some local and remote
subscriber field values in the voice mail database.
- Modify CDR system data and
adjunct machine data on the AUDIX system.
Screens Supported by ADAP
ADAP can retrieve data from the following
system administration and maintenance screens:
Screens supported by ADAP Table
|
|
Screen Name
|
Screen Description
|
|
display activity-log
|
System activity log entries in chronological
order for a selected set of entries.
|
|
display administrator's log
|
Administrator's log entries in chronological
order.
|
|
display alarms
|
Active hardware alarms.
|
|
display alarms
|
Alarms that have been resolved.
|
|
display cos
|
All service options for each class of service.
|
|
display errors
|
Software or hardware errors recorded in the
error log.
|
|
display events
|
Maintenance log entries.
|
|
display fragment
|
Information related to announcement fragments.
|
|
display remote-subscriber
|
Remote subscriber information.
|
|
display subscriber
|
Local subscriber information.
|
|
display subscriber
|
Automated attendant information.
|
|
display system-parameters activity-log
|
Activity log parameters.
|
|
display system-parameters features
|
Type of switch connection, such as system
feature information.
|
|
display system-parameters limits
|
Total system limits, such as max. number of
messages allowed across all subscriber mailboxes, max. number
of errors allowed in the error log, and total number of lists
and list members allowed across all subscriber logins.
|
|
list attendants
|
List of automated attendants.
|
|
list extensions
|
List of local subscribers' names by their
extensions.
|
|
list machines
|
Alphabetical list of names and associated
voice IDs of all network machines (including the local machine).
|
|
list measurements community day
|
Information about daily usage of the sending
restrictions feature. Information is stored for 32 days.
|
|
list measurements community hour
|
Information about hourly usage of the sending
restrictions feature. Information is stored for 32 days.
|
|
list measurements feature day
|
Traffic information for any given day or for
as many as 32 days.
|
|
list measurements feature hour
|
Traffic information for any given hour or
for as many as 192 hours.
|
|
list measurements load day
|
Port traffic information for any given day
or for as many as 32 days.
|
|
list measurements load hour
|
Port traffic information for any given hour
or for as many as 192 hours.
|
|
list measurements remote-messages day
|
Information about message traffic between
the local voice mail system and each remote system for any given
day or for as many as eight days.
|
|
list measurements remote-messages month
|
Information about message traffic between
the local voice mail system and each remote system for any given
month or for as many as 13 months.
|
|
list measurements special-features day
|
Stand-alone and Outcalling traffic for any
given day or for as many as 32 days.
|
|
list measurements special-features hour
|
Stand-alone and Outcalling traffic for any
given hour or for as many as 192 hours.
|
|
list measurements
subscriber day
|
Subscriber traffic information differentiated
between call answer calls and voice mail calls and between prime
time and nonprime time within these categories for any given day
or for as many as eight days.
|
|
list measurements subscriber month
|
Subscriber traffic information differentiated
between call answer calls and voice mail calls and between prime
time and nonprime time within these categories for any given month
or for as many as 13 months.
|
|
list remote-extensions
|
List of remote subscribers' names by their
extensions.
|
|
list remote-text-addresses
|
List of names and text addresses for a given
trusted server.
|
|
list subscribers
|
Alphabetical list of local subscribers by
name.
|
|
list trusted-servers
|
List of trusted servers associated with this
AUDIX system.
|
|
none
|
Call detail recording (CDR) information.
|
|
none
|
Machines administered for use as a CDR PC
or text service machine.
|
|
list measurements network load day
|
Information about the number and duration
of calls on the ACC data ports for any given day or for as many
as 32 days.
|
|
list measurements network load hour
|
Information about the number and duration
of calls on the ACC data ports for any given hour or for as many
as 192 hours.
|
