AUDIX® Administration And Data Acquisition Package Audix Admin Issue 14

User Manual: Audix Admin And Data Acquisition Package Issue 14

Open the PDF directly: View PDF PDF.
Page Count: 488

DownloadAUDIX® Administration And Data Acquisition Package Audix Admin Issue 14
Open PDF In BrowserView PDF
AUDIX®
Administration and Data Acquisition
Package

585-302-502
Comcode 108359167
Issue 14
May 1999

Copyright  1999, Lucent Technologies
All Rights Reserved, Printed in U.S.A.
Notice
Every effort was made to ensure that the information in this book was
complete and accurate at the time of printing. However, information is
subject to change.
Your Responsibility for Your System’s Security
Toll fraud is the unauthorized use of your telecommunications system
by an unauthorized party, for example, persons other than your company’s employees, agents, subcontractors, or persons working on your
company’s behalf. Note that there may be a risk of toll fraud associated
with your telecommunications system and, if toll fraud occurs, it can
result in substantial additional charges for your telecommunications
services.
You and your system manager are responsible for the security of your
system, such as programming and configuring your equipment to prevent unauthorized use. The system manager is also responsible for
reading all installation, instruction, and system administration documents provided with this product in order to fully understand the features that can introduce risk of toll fraud and the steps that can be taken
to reduce that risk. Lucent Technologies does not warrant that this
product is immune from or will prevent unauthorized use of common-carrier telecommunication services or facilities accessed through
or connected to it. Lucent Technologies will not be responsible for any
charges that result from such unauthorized use.
Lucent Technologies Fraud Intervention
If you suspect you are being victimized by toll fraud and you need
technical support or assistance, call the appropriate BCS National Customer Care Center telephone number. Users of the MERLIN®, PARTNER®, and System 25 products should call 1 800 628 2888. Users of
the System 75, System 85, DEFINITY® Generic 1, 2 and 3, and
DEFINITY® ECS products should call 1 800 643 2353. Customers
outside the continental United States should contact their local Lucent
representative, or call one of the above numbers in the following manner:
• Dial the International Access Code; for example, 011.
• Dial the country code for the U.S., that is, 01.
• Lastly, dial either of the telephone numbers provided above.
Lucent Technologies Web Page
The world wide web home page for Lucent Technologies is:
http://www.lucent.com
Federal Communications Commission Statement
Part 15: Class A Statement. This equipment has been tested and
found to comply with the limits for a Class A digital device, pursuant
to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is
operated in a commercial environment. This equipment generates,
uses, and can radiate radio-frequency energy and, if not installed and
used in accordance with the instructions, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference, in which case the
user will be required to correct the interference at his own expense.

Industry Canada (IC) Interference Information
This digital apparatus does not exceed the Class A limits for radio
noise emissions set out in the radio interference regulations of Industry
Canada.
Le Présent Appareil Nomérique n’émet pas de bruits radioélectriques
dépassant les limites applicables aux appareils numériques de la class
A préscrites dans le reglement sur le brouillage radioélectrique édicté
par le Industrie Canada.
Trademarks
See the preface of this document.
Ordering Information
Call:
Lucent Technologies BCS Publications Center
Voice 1 800 457-1235 International Voice 317 322-6791
Fax 1 800 457-1764
International Fax 317 322-6699
Write:
Lucent Technologies BCS Publications Center
2855 N. Franklin Road
Indianapolis, IN 46219
Order:
Document No. 585-302-502
Comcode 108359167
Issue 14, May 1999
For additional documents, refer to the section in “About This Document” entitled “Related Resources.”
You can be placed on a standing order list for this and other documents
you may need. For more information on standing orders, or to be put on
a list to receive future issues of this document, contact the Lucent Technologies Publications Center.
Obtaining Products
To learn more about Lucent Technologies products and to order products, contact Lucent Direct, the direct-market organization of Lucent
Technologies Business Communications Systems. Access their web
site at www.lucentdirect.com. Or call the following numbers: customers 1 800 451 2100, account executives 1 888 778 1880 (voice) or 1
888 778 1881 (fax).
Warranty
Lucent Technologies provides a limited warranty on this product. Refer
to the “Limited Use Software License Agreement” card provided with
your package.
European Union Declaration of Conformity
The “CE” mark affixed to the equipment means that it conforms to the
following directives. Lucent Technologies Business Communications
Systems declares that DEFINITY AUDIX System equipment specified
in this document conforms to the referenced European Union (EU)
Directives and Harmonized Standards listed below:
EMC Directive
89/336/EEC
Low-Voltage Directive73/23/EEC
Acknowledgment
This document was prepared by OMD Technical Publications, Lucent
Technologies, Denver, CO. and Columbus, OH.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

iii

Contents

1

2

Contents

iii

About This Document

xxi

■

Intended Audiences

xxii

■

Prerequisite Skills and Knowledge

xxii

■

Organization of This Document

xxii

■

How to Use This Document

xxiv

■

Conventions Used in This Document

xxv

■

Trademarks and Service Marks

xxv

■

Related Resources

xxvi

■

How to Make Comments About This Document

xxvi

Introduction

1-1

■

Overview

1-1

■

The PC2AUDIX User Interface

1-1

■

The ADAP Command Line Language User Interface

1-2

■

How ADAP Works

1-2

ADAP Data Retrieval

1-2

ADAP Database Modification

1-3

■

Screens Supported by ADAP

1-3

■

Data Retention Considerations

1-7

Installation
■

Installation Requirements
Recommended Hardware Configurations

■

ADAP Directory Structure
ADAP Diskette Contents

■

Installation Procedures

2-1
2-1
2-2
2-2
2-3
2-4

Install ADAP Software

2-4

Install PC2AUDIX Software (Optional)

2-5

Install dBASE III Plus Software (Optional)

2-6

Install Graphics Software (Optional)

2-6

Check Config.sys and Autoexec.bat Files

2-7

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

iv

3

4

Using PC2AUDIX Application Programs

3-1

■

Working in PC2AUDIX

3-2

■

Setting Up PC2AUDIX Interface in a New Work Area

3-3

Creating PC2AUDIX Subdirectories

3-3

Establishing PC2AUDIX Setup Parameters

3-4

Establishing Setup Parameters for Call Detail
Recording (Optional)

3-9

■

Modifying PC2AUDIX Setup Parameters

3-11

■

Setting Up PC2AUDIX Interface in an
Existing Work Area

3-11

■

Starting the PC2AUDIX Interface

3-12

■

PC2AUDIX Root Menu Options

3-13

■

Using On-line Help Files

3-15

■

Directing PC2AUDIX Output

3-15

Redirecting Output to the Screen

3-15

Redirecting Output to a File

3-16

Using Graphical Output

3-16

■

Interrupting the PC2AUDIX Interface

3-16

■

Managing PC2AUDIX Data

3-17

Scheduling PC2AUDIX Processes

3-17

Deleting PC2AUDIX Data

3-17

Generating PC2AUDIX Reports

3-18

PC2AUDIX Data Retrieval

4-1

■

Overview

4-1

■

Prerequisites

4-2

■

Initiating PC2AUDIX Data Retrieval

4-4

■

Hourly System Traffic Data Retrieval

4-5

■

Daily System Traffic Data Retrieval

4-6

■

Monthly System Traffic Data Retrieval

4-7

■

Monthly Subscriber Traffic Data Retrieval

4-8

■

Daily Subscriber Traffic Data Retrieval

4-10

■

Local Subscriber Directory Verification

4-11

■

Remote Subscriber Directory Verification

4-13

■

Call Detail Recording (CDR) Data Retrieval

4-14

■

Performance Statistics Data Retrieval

4-15

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

v

5

6

PC2AUDIX Traffic Reports

5-1

■

Overview

5-1

■

Prerequisites

5-2

■

Producing Traffic Reports

5-2

■

Average Port Usage Report

5-3

■

Peak Port Usage Report

5-5

■

Hourly File System Usage Report

5-8

■

Daily File System Usage Report

5-10

■

Session Usage Traffic Report

5-12

■

Traffic Data Reports

5-14

View Hourly Feature Statistics

5-15

View Daily Feature Statistics

5-18

View Hourly Load Statistics

5-19

View Daily Load Statistics

5-21

View Hourly Network Load Statistics

5-23

View Daily Network Load Statistics

5-25

View Hourly Special Feature Statistics

5-26

View Daily Special Feature Statistics

5-27

View Hourly Community Statistics

5-28

View Daily Community Statistics

5-30

View Daily Remote Message Statistics

5-31

View Monthly Remote Message Statistics

5-32

View Daily Subscriber Statistics

5-34

View Monthly Subscriber Statistics

5-36

■

Remote Traffic Report

5-39

■

Daily System Attendant Traffic Report

5-41

■

Monthly System Attendant Traffic Report

5-44

PC2AUDIX Billing Reports

6-1

■

Overview

6-1

■

Organization Codes

6-2

■

Prerequisites

6-2

■

Starting the Billing Process

6-2

■

Define Price Breakdown

6-3

■

Monthly Bill Calculation

6-7

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

vi
■

7

9

6-8

Generate Organizational Summary Report

6-9

Generate Individual Bill Totals for an
Organization

6-11

Generate Detailed Individual Report by
Organization

6-13

Generate Detailed Individual Report by
Subscriber Name

6-15

PC2AUDIX Database Searches

7-1

■

Overview

7-1

■

Initiating PC2AUDIX Database Searches

7-2

■

List Subscribers with Bills Over Specified Amount

7-3

■

List Subscribers with Usage Over/
Under Specified Limits

7-5

List Subscriber Space Threshold Exceptions

7-7

■

8

Generate Billing Reports

Scheduling PC2AUDIX Data Retrieval

8-1

■

Overview

8-1

■

Scheduling Events

8-2

■

Scheduling Call Detail Recording
(CDR) Data Retrieval

8-8

■

Displaying and Editing Scheduled Events

8-9

■

Displaying the Scheduled Event Log

8-11

PC2AUDIX Site Specific Data

9-1

■

Overview

9-1

■

Selecting Site Specific Data Options

9-2

■

Display/Update Information for Local Subscribers

9-2

■

List All Fields for All Local Subscribers

9-4

■

Display Information for Remote Subscribers

9-6

■

List All Fields for All Remote Subscribers

9-7

10 PC2AUDIX Database Management Tools

10-1

■

Overview

10-1

■

File Naming Conventions

10-2

■

Initiating Data Management Functions

10-2

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

vii
■

■

■

11

Backing Up Retrieved Data

10-3

Back Up Hourly System Traffic Data

10-4

Back Up Daily System Traffic Data

10-5

Back Up Monthly System Traffic Data

10-6

Back Up Monthly Subscriber Traffic Data

10-6

Back Up Daily Subscriber Traffic Data

10-8

Back Up Monthly Billing Data

10-9

Back Up Subscriber Site Data

10-10

Deleting Retrieved Data

10-11

Delete Hourly System Traffic Data

10-12

Delete Daily System Traffic Data

10-13

Delete Monthly System Traffic Data

10-14

Delete Monthly Subscriber Traffic Data

10-15

Delete Daily Subscriber Traffic Data

10-16

Delete Monthly Billing Data

10-17

Restoring Retrieved Data

10-18

Restore Hourly System Traffic Data

10-19

Restore Daily System Traffic Data

10-20

Restore Monthly System Traffic Data

10-21

Restore Monthly Subscriber Traffic Data

10-22

Restore Daily Subscriber Traffic Data

10-23

Restore Monthly Billing Data

10-24

Restore Subscriber Site Data

10-25

Using the ADAP Command Line Language

11-1

■

Overview

11-1

■

Logging Into the Voice Mail System

11-2

Automatic Login Procedure

11-2

Manual Login Procedure

11-5

■

Logging Out of the Voice Mail System

11-8

■

Interrupting a Command

11-8

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

viii
■

Command Line Commands

11-8

Command Format

11-9

Record Description Tables

11-12

Field Types

11-14

Voice Mail Version Columns

11-15

Input Records
Input File Format

11-16
11-16

Optional Input Fields

11-17

Input of Name or Extension
(DEFINITY/INTUITY AUDIX)

11-17

Redirecting Input from Files

11-18

Entering Data from the Keyboard

11-18

Output Records

11-18

Output Record Format

11-18

Delimiters

11-19

Output Field Separator

11-19

Backward Compatibility

11-19

Redirecting Output to Files

11-20

Using Output with dBASE III PLUS

11-20

Return Codes

11-21

■

Data Retrieval Commands

11-22

■

Database Modification Commands

11-24

12 Command Line Database Retrieval Commands

12-1

■

Overview

12-1

■

getaalar

12-2

■

Syntax

12-2

Description

12-2

Errors

12-5

Output Format

12-5

Example

12-6

getadj

12-7

Syntax

12-7

Description

12-7

Errors

12-7

Output Format

12-8

Example

12-9

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

ix
■

■

■

■

■

■

getalogp

12-10

Syntax

12-10

Description

12-10

Errors

12-11

Output Format

12-11

Example

12-11

getannc

12-12

Syntax

12-12

Description

12-12

Errors

12-13

Output Format

12-13

Example

12-13

getatt

12-14

Syntax

12-14

Description

12-14

Errors

12-14

Output Format

12-15

Example

12-15

get_cdr

12-16

Syntax

12-16

Description

12-16

Errors

12-18

Output Format

12-18

Example

12-18

getcomm

12-19

Syntax

12-19

Description

12-19

Errors

12-21

Output Format

12-21

Example

12-24

getcos

12-25

Syntax

12-25

Description

12-25

Errors

12-25

Output Format

12-26

Example

12-27

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

x
■

■

■

■

■

■

getdir

12-28

Syntax

12-28

Description

12-28

Errors

12-29

Output Format

12-29

Example

12-29

geterror

12-30

Syntax

12-30

Description

12-30

Errors

12-32

Output Format

12-33

Example

12-34

getevent

12-35

Syntax

12-35

Description

12-35

Errors

12-37

Output Format

12-38

Example

12-38

getfeat

12-39

Syntax

12-39

Description

12-39

Output Format

12-41

Errors

12-44

Example

12-44

getfrag

12-45

Syntax

12-45

Description

12-45

Errors

12-46

Output Format

12-46

Example

12-46

getlimit

12-47

Syntax

12-47

Description

12-47

Errors

12-47

Output Format

12-48

Example

12-48

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xi
■

12

■

■

■

■

■

getlist

12-50

Syntax

12-50

Description

12-50

Errors

12-51

Output Format

12-51

Example

12-51

getload

12-52

Syntax

12-52

Description

12-52

Errors

12-54

Output Format

12-54

Example

12-66

getlog

12-67

Syntax

12-67

Description

12-67

Errors

12-69

Output Format

12-69

Example

12-70

getmaint

12-71

Syntax

12-71

Description

12-71

Errors

12-73

Output Format

12-73

Example

12-74

getmlist

12-75

Syntax

12-75

Description

12-75

Errors

12-76

Output Format

12-76

Example

12-76

getnet

12-77

Syntax

12-77

Description

12-77

Output Format

12-78

Example

12-88

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xii
■

■

■

■

■

getperf

12-89

Syntax

12-89

Description

12-89

Errors

12-90

Output Format

12-91

General Information

12-91

Example

12-91

Data Types

12-100

Performance Data to be Collected

12-101

Data Collection

12-109

Output Format for Each Data Type

12-109

getralar

12-111

Syntax

12-111

Description

12-111

Errors

12-114

Output Format

12-114

Example

12-115

getrem

12-116

Syntax

12-116

Description

12-116

Errors

12-118

Output Format

12-118

Example

12-121

getrlist

12-122

Syntax

12-122

Description

12-122

Errors

12-123

Output Format

12-123

Example

12-123

getrsub

12-124

Syntax

12-124

Description

12-124

Errors

12-125

Input Format

12-125

Output Format

12-126

Example

12-128

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xiii
■

■

■

■

■

getserve

12-129

Syntax

12-129

Description

12-129

Errors

12-130

Output Format

12-130

Example

12-130

getspfea

12-131

Syntax

12-131

Description

12-131

Errors

12-133

Output Format

12-133

Example

12-136

getsub

12-137

Syntax

12-137

Description

12-137

Errors

12-138

Input Format

12-138

Output Format

12-139

Example

12-141

getswitc

12-142

Syntax

12-142

Description

12-142

Errors

12-142

Output Format

12-143

Example

12-143

getsys

12-144

Syntax

12-144

Description

12-144

Errors

12-145

Output Format

12-146

Example

12-146

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xiv
■

■

■

■

■

getsysat

12-147

Syntax

12-147

Description

12-147

Errors

12-148

Input Format

12-148

Output Format

12-148

Example

12-150

getsyscd

12-151

Syntax

12-151

Description

12-151

Errors

12-151

Output Format

12-152

Example

12-152

getsysfe

12-153

Syntax

12-153

Description

12-153

Errors

12-153

Output Format

12-154

Output Format

12-156

Example

12-158

gettlist

12-159

Syntax

12-159

Description

12-159

Errors

12-160

Output Format

12-160

Example

12-160

gettraf

12-161

Syntax

12-161

Description

12-161

Errors

12-163

Input Format

12-163

Output Format

12-164

Example

12-169

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xv

13 Command Line Database Modification Commands

13-1

■

Overview

13-1

■

addrsub

13-2

■

■

■

■

Syntax

13-2

Description

13-2

Input Format

13-3

Output Format

13-3

Example

13-3

addsub

13-4

Syntax

13-4

Description

13-4

Input Format

13-5

Output Format

13-5

Example

13-6

changcex

13-7

Syntax

13-7

Description

13-7

Errors

13-8

Input Format

13-8

Output Format

13-8

Example

13-8

changcom

13-9

Syntax

13-9

Description

13-9

Errors

13-10

Input Format

13-10

Output Format

13-10

Example

13-10

changcos

13-11

Syntax

13-11

Description

13-11

Errors

13-12

Input Format

13-12

Output Format

13-12

Example

13-12

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xvi
■

■

■

■

■

changext

13-13

Syntax

13-13

Description

13-13

Errors

13-14

Input Format

13-14

Output Format

13-14

Example

13-14

changmis

13-15

Syntax

13-15

Description

13-15

Errors

13-16

Input Format

13-16

Output Format

13-16

Example

13-16

changmsg

13-18

Syntax

13-18

Description

13-18

Errors

13-19

Input Format

13-19

Output Format

13-19

Example

13-19

changnam

13-20

Syntax

13-20

Description

13-20

Errors

13-21

Input Format

13-21

Output Format

13-21

Example

13-21

changpwd

13-22

Syntax

13-22

Description

13-22

Errors

13-23

Input Format

13-23

Output Format

13-23

Example

13-23

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xvii
■

■

■

■

■

changsub

13-24

Syntax

13-24

Description

13-24

Errors

13-25

Input Format

13-25

Output Format

13-27

Example

13-29

changsw

13-31

Syntax

13-31

Description

13-31

Errors

13-32

Input Format

13-32

Output Format

13-32

Example

13-32

changtex

13-33

Syntax

13-33

Description

13-33

Errors

13-34

Input Format

13-34

Output Format

13-34

Example

13-35

chgrcom

13-36

Syntax

13-36

Description

13-36

Errors

13-37

Input Format

13-37

Output Format

13-37

Example

13-37

chgrext

13-38

Syntax

13-38

Description

13-38

Errors

13-39

Input Format

13-39

Output Format

13-39

Example

13-39

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xviii
■

■

■

■

■

chgrmach

13-40

Syntax

13-40

Description

13-40

Errors

13-41

Input Format

13-41

Output Format

13-41

Example

13-41

chgrnam

13-42

Syntax

13-42

Description

13-42

Errors

13-43

Input Format

13-43

Output Format

13-43

Example

13-43

delrsub

13-44

Syntax

13-44

Description

13-44

Errors

13-45

Input Format

13-45

Output Format

13-45

Example

13-45

delsub

13-46

Syntax

13-46

Description

13-46

Errors

13-47

Input Format

13-47

Output Format

13-47

Example

13-47

setadj

13-48

Syntax

13-48

Description

13-48

Errors

13-49

Example

13-50

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xix
■

■

A

B

setalogp

13-51

Syntax

13-51

Description

13-51

Errors

13-52

Example

13-52

setscdr

13-53

Syntax

13-53

Description

13-53

Errors

13-54

Example

13-54

Troubleshooting

A-1

■

Establishing a Connection to the System

A-1

■

Terminating the Connecting to the System

A-1

■

Retrieving Data During Peak Usage

A-1

■

Interactions Between Terminals On AUDIX Systems

A-2

■

Timeouts

A-2

■

Data Acquisition Problems

A-2

■

Alogin (Automated Login) Problems

A-3

■

Common Problems and Solutions

A-3

Connection Problems with Login Commands:

A-3

Problems Encountered During Data Retrieval or
Database Modification:

A-4

RS-232 Driver Errors
■

Converting Error Return Codes into
RS-232 Driver Error Codes

B-1
B-1

AB Abbreviations

AB-1

GL Glossary

GL-1

IN

IN-1

Index

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Contents

xx

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

About This Document

xxi

About This Document

This document describes how to use ADAP, the PC-based Administration and
Data Acquisition Package which allows voice mail customers to transfer 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 these voice mail systems:
■

Lucent INTUITY AUDIX R2.0, R3.2, R3.3, R4.0 and R5.0 systems

■

DEFINITY AUDIX R3.2 and earlier system versions

■

AUDIX R1V8 and earlier system versions

However, the Lucent INTUITY AUDIX version of ADAP works only for INTUITY
AUDIX System, and the AUDIX/DEFINITY AUDIX version works only with R1
AUDIX and DEFINITY AUDIX Systems.
ADAP gives you two ways 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. Using the command line language programmers can modify
also subscriber data in the voice mail system.

■

PC2AUDIX is a a menu-driven application allowing system administrators
to download data from the voice mail system to the PC and to use for
generating standardized traffic and billing reports with dBASE III PLUS™
software.
NOTE:
You cannot use PC2AUDIX with INTUITY AUDIX systems.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

About This Document
Intended Audiences

xxii

Intended Audiences
This document contains information for the following two audiences:
■

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

■

System administrators who use PC2AUDIX to:
— Retrieve DEFINITY AUDIX or AUDIX data to the PC
— Generate standardized reports
— Modify subscriber records directly in the DEFINITY AUDIX or
AUDIX database

Prerequisite Skills and Knowledge
The system administrators who use the PC2AUDIX interface must know how to
use a PC. Knowledge of the dBASE III PLUS database management system is
helpful but not required.
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, DEFINITY AUDIX, or AUDIX administration
screens.

Organization of This Document
This document is organized as follows:
■

Chapter 1, "Introduction", describes what ADAP does and how it works,
introduces the two user interfaces that can be used, and lists the voice
mail administration screens supported by ADAP.

■

Chapter 2, "Installation" , describes ADAP installation requirements,
describers the ADAP directory structure on the PC, and tells you how to
install the ADAP software.

■

Chapter 3, "Using PC2AUDIX Application Programs", describes how to set
up and use the PC2AUDIX interface.

■

Chapter 4, "PC2AUDIX Data Retrieval", describes how to verify the
subscriber directory and to download database information to the PC. It
also tells you how to initiate data collection on demand and schedule data
collection for off-hours execution.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

About This Document
Organization of This Document

xxiii

■

Chapter 5, "PC2AUDIX Traffic Reports", describes how to produce
standardized traffic reports using data that was previously retrieved from
the DEFINITY AUDIX or AUDIX database.

■

Chapter 6, "PC2AUDIX Billing Reports", describes how to produce
standardized billing reports using data that was previously retrieved from
the DEFINITY AUDIX or AUDIX database.

■

Chapter 7, "PC2AUDIX Database Searches", describes how to list
subscribers with bills over specified amounts, to list subscribers with
usage over/under a specified amount, and to list subscriber space
threshold exceptions.

■

Chapter 8, "Scheduling PC2AUDIX Data Retrieval", describes how to
schedule events, display and edit scheduled events, display the event
log, and schedule Call Detail Recording (CDR) data retrieval when CDR is
included with your AUDIX system.

■

Chapter 9, "PC2AUDIX Site Specific Data", describes how to display and
update information for local and remote subscribers.

■

Chapter 10, "PC2AUDIX Database Management Tools", describes how to
back up retrieved data, restore backed up data, and delete retrieved data
from the PC.

■

Chapter 11, "Using the ADAP Command Line Language", describes how
to use the ADAP command line language to retrieve data from the voice
mail database or to modify subscriber data in the database.

■

Chapter 12, "Command Line Database Retrieval Commands", lists and
describes commands that download information directly from the voice
mail database for use in customer-developed applications.

■

Chapter 13, "Command Line Database Modification Commands", lists and
describes commands that modify subscriber information in the voice mail
database.

■

Appendix A, "Troubleshooting", provides possible solutions for problems
that may occur while using the PC2AUDIX interface or the ADAP
command line language.

■

Appendix B, "RS-232 Driver Errors", lists driver error codes and
instructions for interpreting them.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

About This Document
How to Use This Document

xxiv

How to Use This Document
This document reflects the unique interests, requirements, and skill levels of the
diverse audiences who use ADAP. Information is organized in Fs that meet the
specific technical requirements of each audience.
If you are a programmers using the ADAP command line language, you will use
the following chapters:
■

Chapter 1, "Introduction"

■

Chapter 2, "Installation"

■

Chapter 11, "Using the ADAP Command Line Language"

■

Chapter 12, "Command Line Database Retrieval Commands"

■

Chapter 13, "Command Line Database Modification Commands"

■

Appendix A, "Troubleshooting"

If you are a system administrator using PC2AUDIX, you will use the following
chapters:
■

Chapter 1, "Introduction"

■

Chapter 2, "Installation"

■

Chapter 3, "Using PC2AUDIX Application Programs"

■

Chapter 4, "PC2AUDIX Data Retrieval"

■

Chapter 5, "PC2AUDIX Traffic Reports"

■

Chapter 6, "PC2AUDIX Billing Reports"

■

Chapter 7, "PC2AUDIX Database Searches"

■

Chapter 8, "Scheduling PC2AUDIX Data Retrieval"

■

Chapter 9, "PC2AUDIX Site Specific Data"

■

Chapter 10, "PC2AUDIX Database Management Tools"

■

Appendix A, "Troubleshooting"

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

About This Document
Conventions Used in This Document

xxv

Conventions Used in This Document
The following conventions are used throughout this document:

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 it isn’t required.

Rounded box

Encloses the name of a key that you will press.
Example:

Squared box

RETURN

Encloses the name of an action performed by the
software program.
Example: NEWLINE is a carriage return followed by a
linefeed, a combined action automatically performed by
the software at the end of each output record.

Trademarks and Service Marks
The following trademarks are mentioned throughout this document:
■

INTUITY® is a registered trademark of Lucent Technologies.

■

AUDIX® is a registered trademark of Lucent Technologies.

■

dBASE III PLUS™ is a trademark of Ashton-Tate.

■

DEFINITY® is a registered trademark of Lucent Technologies.

■

Microsoft® is a registered trademark of Microsoft Corporation.

■

MS-DOS® is a registered trademark of Microsoft Corporation.

■

UNIX® is a registered trademark of UNIX Systems Laboratories.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

About This Document
Related Resources

xxvi

Related Resources
For a complete description of the screens discussed in this document, refer to
the manual corresponding to your voice mail system:
■

DEFINITY AUDIX System — Screens Reference, 585-300-211

■

AUDIX Release 1 Version 8 Forms Reference, 585-305-209

Full instructions for using dBASE III PLUS database file structures can be found
in the manuals supplied with that software package.
To order additional Lucent Technologies documents, call the Lucent
Technologies Customer Information Center by dialing the toll free number
(1-800-432-6600) and requesting each item by the appropriate document
number.
For information about other DEFINITY AUDIX system or R1 AUDIX system
documents, refer to the documentation guide corresponding to your voice mail
system:
■

DEFINITY AUDIX System Documentation Guide, 585-300-011

■

AUDIX Documentation Guide, 585-300-011

How to Make Comments About This
Document
While we have tried to make this document fit your needs, we appreciate your
suggestions for its improvement. If you have any suggestions for improving this
document or a similar document, please send them to us on the reader comment
card. You will find the card behind the title page of this document.
If your reader comment card has been removed, please mail your comments to:
Lucent Technologies
Product Documentation Development Department
Room 22-2H15
11900 North Pecos Street
DENVER CO 80234 -2703

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
Overview

1-1

Introduction

1

Overview
The AUDIX Administration and Data Acquisition Package (ADAP) allows INTUITY
AUDIX, DEFINITY AUDIX, and AUDIX customers to download traffic data,
subscriber data, and other system data from the voice mail system to the PC for
further processing.
ADAP has two user interfaces: a menu-driven application called PC2AUDIX used
by system administrators, and a command line language used by programmers.
Each of these interfaces is described separately in this manual.

The PC2AUDIX User Interface
The PC2AUDIX interface is a menu-driven application program that runs under
dBASE III PLUS software. Using PC2AUDIX you can download data from a
DEFINITY AUDIX or AUDIX system to the PC and create standardized traffic
reports and billing reports using this data. Because PC2AUDIX uses the ADAP
command line language both ADAP software and dBASE III PLUS software must
reside on your PC before using PC2AUDIX.
NOTE:
If the Stella Business Graphics package is installed on your PC, PC2AUDIX
reports can be presented as bar charts and line charts. The Stella Business
Graphics package is no longer available, but you may have purchased it
with a previous version of the ADAP software.
Chapter 3 through Chapter 10 describe how to use the PC2AUDIX interface.

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
The ADAP Command Line Language User Interface

1-2

The ADAP Command Line Language
User Interface
The ADAP command line language provides a set of commands that
programmers can use to modify subscriber information directly in the voice mail
database and also to download data from voice mail database files to the PC for
use in customer-developed applications.
Chapter 11 through Chapter 13 describe how to use the ADAP command line
language.

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. For the PC2AUDIX
interface, the software automatically logs into the voice mail system whenever it
needs access to the database.
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 this 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,
With PC2AUDIX, data is retrieved to a file.You can then process the retrieved
data on the PC using custom-developed dBASE III PLUS programs or formatted
the data in standardized dBASE III PLUS reports using PC2AUDIX menu options.
NOTE:
To register for a class on dBASE III PLUS, call your account team to see if a
local class is held in your area.

ADAP Data Retrieval
Data can be retrieved in four ways:
■

You can use PC2AUDIX menu options to retrieve data to your PC in a
dBASE III PLUS-compatible format.

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
Screens Supported by ADAP

1-3

■

You can write application programs using ADAP command line language
commands to retrieve database information to your PC. Data is written in a
flat ASCII format that can be read using dBASE III PLUS.

■

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

■

Modify activity log system parameters on the DEFINITY AUDIX system

Screens Supported by ADAP
ADAP can retrieve data from the following system administration and
maintenance screens:

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
Screens Supported by ADAP

Table 1-1.

1-4

Screens Supported by ADAP

DEFINITY/INTUITY AUDIX
Screen Name

R1 AUDIX
Screen Name

display activity-log

system activity log display

System activity log entries in
chronological order for a
selected set of entries

display
administration-log
(DEFINITY AUDIX only)

system log display

Administration log entries in
chronological order

display administrator’s
log
(INTUITY AUDIX only)

none

Administrator’s log entries in
chronological order

display alarms

maintenance active alarm
display

Active hardware alarms

display alarms

maintenance resolved
alarm display

Alarms that have been resolved

display cos

class of service

All service options for each
class of service

display errors

maintenance error display

Software or hardware errors
recorded in the error log

display events
(DEFINITY AUDIX only)

none

Internal events

display fragment

system announcement
detail

Information related to
announcement fragments

display events
(INTUITY AUDIX only)

none

Maintenance log entries

display
remote-subscriber

subscriber remote

Remote subscriber information

display subscriber

subscriber local

Local subscriber information

display subscriber

system attendant

Automated attendant
information

display
system-parameters
activity-log

none

Activity log parameters

display
system-parameters
features

system translation switch
connection

Type of switch connection,
such as dciu-sci.DEFINITY
AUDIX system feature
information.

Screen Description

Continued on next page

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
Screens Supported by ADAP

Table 1-1.

1-5

Screens Supported by ADAP — Continued

DEFINITY/INTUITY AUDIX
Screen Name

R1 AUDIX
Screen Name

display
system-parameters limits

system 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 attendant

List of automated attendants

list extensions

list extension local

List of local subscribers’ names
by their extensions

list machines

list machine

Alphabetical list of names and
associated voice IDs of all
network machines (including
local machine)

list measurements
community day

traffic community day

Information about daily usage
of the sending restrictions
feature

list measurements
community hour

traffic community hour

Information about hourly usage
of the sending restrictions
feature

list measurements
feature day

traffic feature day

Traffic information for any given
day or for as many as 8 days

list measurements
feature hour

traffic feature hour

Traffic information for any given
hour or for as many as 192
hours

list measurements load
day

traffic load day

Port traffic information for any
given day or for as many as 32
days

list measurements load
hour

traffic load hour

Port traffic information for any
given hour or for as many as
192 hours

list measurements
remote-messages day

traffic 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

Screen Description

Continued on next page

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
Screens Supported by ADAP

Table 1-1.

1-6

Screens Supported by ADAP — Continued

DEFINITY/INTUITY AUDIX
Screen Name

R1 AUDIX
Screen Name

list measurements
remote-messages month

traffic 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

traffic special features day

Standalone and Outcalling
traffic for any given day or for
as many as eight days

list measurements
special-features hour

traffic special features
hour

Standalone and Outcalling
traffic for any given hour or for
as many as 192 hours

list measurements
subscriber day

traffic 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

traffic 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 extension remote

List of remote subscribers’
names by their extensions

list
remote-text-addresses
(INTUITY AUDIX only)

none

List of names and text
addresses for a given trusted
server

list subscribers

list subscriber

Alphabetical list of local
subscribers by name

list trusted-servers
(INTUITY AUDIX only)

none

List of trusted servers
associated with this AUDIX
system

none

system cdr

Call detail recording (CDR)
information

Screen Description

Continued on next page

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
Data Retention Considerations

Table 1-1.

1-7

Screens Supported by ADAP — Continued

DEFINITY/INTUITY AUDIX
Screen Name

R1 AUDIX
Screen Name

Screen Description

system translation
machine adjunct

Machines administered for use
as a CDR PC or text service
machine

list measurements
network load day

traffic 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

traffic 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

Continued on next page

For a complete description of these screens, refer to DEFINITY AUDIX System —
Screens Reference, 585-300-207, or the AUDIX Release 1 Version 8 Forms
Reference, 585-306-204. For a table describing the relationships between screen
names, commands, and the voice mail versions, see Chapter 11, "Using the
ADAP Command Line Language".

Data Retention Considerations
To retain traffic data, you must activate traffic collection using the DEFINITY
AUDIX System-Parameters Feature screen, or the AUDIX System: Appearance
screen). This initiates traffic data collection on the voice mail system. You must
activate the traffic collection feature for at least as many days in the past as you
want to retrieve traffic data.
The voice mail systems do not retain collected traffic data for an indefinite period.
You must retrieve collected traffic data from the voice mail system in a timely
fashion before it is deleted from the system by internal audits.

AUDIX Administration and Data Acquisition Package 585-302-502

1

Issue 14
May 1999

Introduction
Data Retention Considerations

1-8

Information for the following screens is stored for 192 hours (eight days):

DEFINITY/INTUITY AUDIX Systems

R1 AUDIX System

list measurements feature hour

traffic feature hour

list measurements load hour

traffic load hour

list measurements community hour

traffic community hour

list measurements special-features hour

traffic special features hour

list measurements network-load hour

traffic network load hour

Information for the following screens is stored for 32 days:

DEFINITY/INTUITY AUDIX Systems

R1 AUDIX System

list measurements feature day

traffic feature day

list measurements load day

traffic load day

list measurements community day

traffic community day

list measurements special-features day

traffic special features day

list measurements network-load day

traffic network load day

Information for the following screens is stored for eight days:

DEFINITY/INTUITY AUDIX System

R1 AUDIX System

list measurements remote-messages day

traffic remote messages day

list measurements subscriber day

traffic subscriber day

Information for the following screens is stored for 13 months:

DEFINITY/INTUITY AUDIX Systems

R1 AUDIX System

list measurements remote-messages month

traffic remote messages month

list measurements subscriber month

traffic subscriber month

AUDIX Administration and Data Acquisition Package 585-302-502

2

Issue 14
May 1999

Installation
Installation Requirements

Installation

2-1

2

This chapter tells you how to install ADAP software on your PC. This consists of
the following three tasks, described in detail later in this chapter.
1. Determine that required hardware is in place and configured properly.
2. Understand how the ADAP directories are organized on your PC.
3. Perform the installation. Installation procedures are the same whether you
install ADAP for the first time or upgrade from an earlier version of ADAP.

Installation Requirements
Before you install the ADAP software, check that your PC system consists of the
following:
■

An IBM-compatible PC with:
— A minimum of 640 KB of RAM
— A 3.5” 1.44 MB or 5.25” 1.2 MB floppy disk drive (DEFINITY AUDIX
and R1 AUDIX systems)
— A 3.5” 1.44 MB floppy disk drive (INTUITY AUDIX systems)
— One fixed disk (hard drive) with a minimum of 40 MB of storage
— MS-DOS 3.1 or newer
NOTE:
If you have AUDIX Call Detail Recording (CDR), refer to AUDIX Call
Detail Recording Package, 585-305-506, for the CDR hardware
requirements. The DEFINITY AUDIX and INTUITY AUDIX systems do
not support CDR.

AUDIX Administration and Data Acquisition Package 585-302-502

2

Issue 14
May 1999

Installation
ADAP Directory Structure

2-2

The following, optional items enhance and expand your use of the ADAP
software; they are available only for DEFINITY AUDIX and R1 AUDIX systems:
■

dBASE III PLUS, Version 1.1, supplied by you, the customer, is needed to
run the PC2AUDIX portion of ADAP. You can also use dBASE III PLUS with
application programs you develop.

■

Stella Business Graphics package or other graphics software, also
provided by the customer, which generates charts and graphs using data
from PC2AUDIX. This is optional. The dBASE utilities do not work with
Stella Business Graphics II.
NOTE:
The Stella Business Graphics package is no longer available, but
you may have purchased it with a previous version of the ADAP
software.

■

A PC–compatible, parallel port printer for printing text files.

Recommended Hardware Configurations
Your PC must be connected to the voice mail system through one of the following
configurations:
■

Directly, with a Group 311 RS-232 cable connected from your PC to a
Group 350 null modem cable, which in turn is connected to:
— Port A on the DEFINITY AUDIX or INTUITY AUDIX system
or
— The local administration terminal (LAT) connector on the back of the
R1 AUDIX system
The length of the RS-232 cable should not exceed 50 feet.

■

Through a switch using a Hayes-compatible modem

■

Through a switch using Modular Processor Data Module (MPDM)

ADAP Directory Structure
When you install the ADAP software for DEFINITY AUDIX/R1 AUDIX, the default
directory used by the ADAP setup software is PCIFCE unless the ADAPROOT
environment variable is set otherwise. Likewise, when you install the ADAP
software for INTUITY AUDIX, the default directory used by the ADAP setup
software is INT_ADAP, unless the ADAPROOT environment variable is set
otherwise. After installation is complete, these directories contain the appropriate
ADAP software. (See the following diagram.) Since both directories contain
programs with the same names, the PATH environment variable indicates which
of the two directories are to be used when you execute the ADAP software. You
must create the machine directories (, , etc.) according

AUDIX Administration and Data Acquisition Package 585-302-502

2

Issue 14
May 1999

Installation
ADAP Directory Structure

2-3

to instructions in Chapter 3; they will contain the data that you retrieve from each
voice mail machine using ADAP. If you are working with more than one voice mail
machine, you need to create a directory corresponding to each machine.

Root Directory

 PCIFCE INT_ADAP


(optional)


(optional)


(optional)

Installing PC2AUDIX, DBASEIII, and Stella Business Graphics creates the
additional directories and subdirectories shown in the figure below. The DBASE
directory contains the dBASEIII software, and the DB3_PROG.DIR and DB3_
STRU.DIR subdirectories to contain related dBASEIII program files and
database structures. The SBG directory contains the Stella Business Graphics,
software and the KEYFILES subdirectory contains links between PC2AUDIX and
Stella Business Graphics for running graphic reports.
Root Directory

 DBASE

SBG
PCIFCE
(optional)

DB3_PROG.DIR

INT_ADAP   

DB3_STRU.DIR

AUDIX

(optional)

(optional)

(optional)

KEYFILES

DEFAUDIX

ADAP Diskette Contents
Each diskette contains a readme file that lists the ADAP files and directories
contained on that diskette. To display the contents of the readme file, insert the
diskette in drive A and enter type a:readme at the DOS prompt. (If you use a
drive other than A, enter it instead.)
The ADAP software is contained on either 5-1/4-inch or 3-1/2-inch diskettes. Use
the diskettes that fit your PC.

AUDIX Administration and Data Acquisition Package 585-302-502

2

Issue 14
May 1999

Installation
Installation Procedures

2-4

Installation Procedures
Installation procedures are the same whether you are installing ADAP for the first
time or upgrading from an earlier version of the ADAP software.
To install ADAP, you will perform the five following procedures, in the following
order (note that the second, third, and fourth tasks are optional and pertain only
to DEFINITY AUDIX and R1 AUDIX systems):
1. Install the ADAP software.
2. Install the PC2AUDIX software, which also sets up database file structures
on your PC (DEFINITY AUDIX and R1 AUDIX systems only). You must
install the ADAP software before installing PC2AUDIX software.
NOTE:
PC2AUDIX does not operate with INTUITY AUDIX systems.
3. Install the customer-provided dBASE III PLUS database management
software package (DEFINITY AUDIX and R1 AUDIX systems only).
4. Install graphics software (optional).
5. Verify that the config.sys and autoexec.bat files are set up properly for
ADAP.

Install ADAP Software
Perform the following steps to install the ADAP software. Installation automatically
builds the required subdirectories if they do not exist already.
1. ADAP software is installed by default to C:\PCIFCE or C:\INT_ADAP. If
you want to install to a different subdirectory or drive, insert the following
environment variable definition in your autoexec.bat file, and reboot your
PC:
SET ADAPROOT=:\
(where  is the drive letter and  is the directory path
name)
2. Insert AUDIX Administration and Data Acquisition Software, Disk 1 into
your floppy disk drive.
3. At the DOS prompt, enter a: RETURN to change to drive A. (If you use a
diskette drive other than drive A, enter that drive letter instead.)
4. Enter setup.
You are prompted for your floppy disk drive.
5. Enter your floppy disk drive letter name, or press Enter to default to drive
a:.
The Setup For AUDIX PC Software menu appears.

AUDIX Administration and Data Acquisition Package 585-302-502

2

Issue 14
May 1999

Installation
Installation Procedures

2-5

6. Press a to select Install ADAP Command Line Software.
The Install ADAP Command Line Software screen appears.
7. Press i to select Install.
Messages describing installation progress appear. When installation of
the disk is finished, if there are more disks to install you are prompted to
insert the next disk. Each disk takes about a minute to install.
8. Insert the next disk and press any key to continue.
9. Repeat Step 8 for each diskette requested by the Setup program.
When installation is finished, an Installation Complete message appears.
10. Press any key to continue.
The Setup for AUDIX PC Software menu appears.
If you plan to use the PC2AUDX reporting package, install PC2AUDIX, according
to the following section. Otherwise, press q to quit the setup program and go to
the "Check Config.sys and Autoexec.bat Files" later in this chapter.
NOTE:
If you quit, and this is an initial installation, you must reboot the PC.

Install PC2AUDIX Software (Optional)
If you are upgrading from a previous version, PC2AUDIX preserves any
previously-retrieved data. If you are migrating from an R1 AUDIX to DEFINITY
AUDIX machine, PC2AUDIX automatically converts the data to the DEFINITY
AUDIX format. However, PC2AUDIX cannot convert DEFINITY AUDIX data to
R1 AUDIX format.
To install the PC2AUDIX software, perform the following steps:
1. In the Setup for AUDIX PC Software screen, press p to select Install
PC2AUDIX Application Software.
The Install PC2AUDIX Application Software screen appears.
2. Insert the first PC2AUDIX disk
3. Press i to install the PC2AUDIX program software.
Messages describing installation progress appear. This takes about five
minutes to install.
When the PC2AUDIX installation is finished, an Installation Complete
message appears.
4. Press any key to display the Setup menu.
5. In the Setup menu, enter q for quit the setup program.

AUDIX Administration and Data Acquisition Package 585-302-502

2

Issue 14
May 1999

Installation
Installation Procedures

2-6

The PC2AUDIX installation is completed successfully and the DOS prompt
appears.
NOTE:
Installation copies all PC2AUDIX database structures to your PC,
except those contained in the TEMPLATE subdirectory. These are
useful if you are developing your own application programs. If you
wish, look at the contents of the TEMPLATE subdirectory on the
floppy disks and copy them to your PC if you want to use them.
Now that PC2AUDIX is installed, proceed to the next procedure to install
dBASE III, which is required to run PC2AUDIX.
NOTE:
PC2AUDIX, dBASE III, and graphics software only operate with DEFINITY
AUDIX and R1 AUDIX systems.

Install dBASE III Plus Software (Optional)
You must install the dBASE III PLUS database management package in order to
you use PC2AUDIX. If dBASE III PLUS is not installed already, perform the
following steps:
1. At the DOS prompt, enter mkdir dbase to create a subdirectory named
dbase. This directory is where the dBASE III PLUS programs will reside on
your PC.
2. Enter cd dbase to access the subdirectory that you just created.
3. Install the dBASE III PLUS software as instructed in the dBASE III PLUS
installation document, Getting Started, dBASE III PLUS, 10060-0214.
Now that dBASE III is installed, you can proceed with the next procedure to install
the graphics software, or skip to the last procedure to check the config.sys and
autoexec.bat files.

Install Graphics Software (Optional)
If you purchased the Stella Business Graphics Package when it was available,
you may need to install or re-install the package. To do so, perform the following
steps:
1. At the DOS prompt, enter mkdir sbg to create the directory where the
Stella Business Graphics programs will reside.
2. Enter cd sbg to access the sbg subdirectory that you just created.
3. Install the Stella Business Graphics package as instructed in Stella
Business Graphics Twelve Formats for Powerful Charts and Graphs.

AUDIX Administration and Data Acquisition Package 585-302-502

2

Issue 14
May 1999

Installation
Installation Procedures

2-7

4. Use the setup.exe program included with the Stella Business Graphics
package to set up Stella to use either the Epson dot matrix printer or the
Hewlett-Packard LaserJet printer. This entry must match the entry in the
PC2AUDIX Setup Parameters Printer Type field.

Check Config.sys and Autoexec.bat Files
The installation automatically modifies data in the config.sys and autoexec.bat
files. Perform the following steps to ensure that these changes were made:
1. At the DOS prompt, enter type config.sys to display the contents of the
config.sys file.
2. Check for the rs232 device line:
device=c:\pcifce\ex_rs232.bin
This line identifies the device driver for communicating with the voice mail
system. If it is not present, use your text editor to add it to the file. (If you
changed the ADAP software subdirectory to a name other than PCIFCE or
INT_ADAP, the name you changed it to should appear in the file.)
3. Check for the following device line, which tells ADAP how to write things to
the screen:
device=c:\dos\ansi.sys
4. At the DOS prompt, enter type autoexec.bat to display the contents of the
autoexec.bat file.
5. Check for the line that begins with PATH= and validate the following:
a. You should see the entry c:\pcifce or c:\int_adap on this
line.
If you installed ADAP to a directory other than either of these, the
name you changed it to should appear on this line.
b. If you installed dBASE III PLUS, you should see:
c:\dbase in the PATH= line.
c. If you installed Stella Business Graphics, you should see:
c:\sbg in the PATH= line.
6. If the above entries are not included in your autoexec.bat file, use your text
editor to add them to the file.
7. If you made any changes in the previous steps, reboot your system.
Now that you have completed installation, you need to create a separate work
area corresponding to each machine. To do this, follow the instructions in "Setting
Up PC2AUDIX Interface in a New Work Area" in Chapter 3.

AUDIX Administration and Data Acquisition Package 585-302-502

2

Installation
Installation Procedures

Issue 14
May 1999
2-8

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs

3-1

Using PC2AUDIX Application
Programs

3

PC2AUDIX is a menu-driven application that downloads selected voice mail data
to your PC, and works with dBASE III PLUS software to generate standardized
traffic and billing reports. PC2AUDIX also provides tools for managing retrieved
data on the PC.
Using PC2AUDIX you can:
■

Retrieve traffic and subscriber data to the PC

■

Retrieve AUDIX system Call Detail Recording (CDR) data to the PC

■

Generate standardized traffic reports on the PC displayed in table format
or in graphical format with a compatible graphics package

■

Generate subscriber usage billing reports on the PC

■

Generate reports that reveal how subscribers use the voice mail system
(such as who creates voice mail messages and how many, who allows
mailboxes to reach a certain percentage, and who the heavy users are)

■

Schedule data retrieval from local and network machines for on-hours or
off-hours execution

■

Display individual local and remote subscriber records

■

Update specific PC2AUDIX data fields in PC2AUDIX subscriber records
(and Name and Ext fields in the subscriber database)

■

Back up, restore, and delete retrieved voice mail database files from your
PC’s fixed disk
NOTE:
PC2AUDIX does not work with the INTUITY AUDIX system.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Working in PC2AUDIX

3-2

Working in PC2AUDIX
Before using PC2AUDIX, you must first install the ADAP and PC2AUDIX software
onto your PC following the installation instructions in Chapter 2. You also must
install dBASE III PLUS software, as described in Chapter 2, to use PC2AUDIX.
While working in PC2AUDIX you use screens to enter report parameters and
generate reports. The keys described below are your tools for moving around the
screen and entering values in the data entry fields:

moves to the next field
moves to the previous field
moves back one character
moves forward one character
RETURN

moves to the start of the next field

Ctrl-y

erases to the end of the field

INS

toggles insert mode on or off

DEL

erases the character under the cursor

Function keys appear at the bottom of each PC2AUDIX screen. Each display
key corresponds to a function key on your keyboard.The most typically used
function keys are shown below:

F4

(NEXT PAGE)

displays the next page of data for multiple-page
screens

F5

(PRINT FORM)

prints the screen with three screens to a printed page

F6

(PREV REC)

displays the previous record on the same screen

F7

(PREV FORM

returns to the previously-displayed screen

F8

(CHANGE/RUN)

saves changes that were made or starts execution of
the screen. Screens containing modifiable fields do
not start execution until you press F8
(CHANGE/RUN).

F9

(ROOT MENU)

returns to the PC2AUDIX Root Menu

F10

(HELP)

displays PC2AUDIX on-line help for the screen

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

3-3

NOTE:
If you enter an invalid date in a date field, such as 99/99/99, dBASE III
PLUS does not allow you to leave that field, and function keys (including
HELP) do not function properly. You can either enter a valid date, or press
the ESC key to restore the date field to its initial value. Make cautious use of
the ESC key, or you may unintentionally halt a PC2AUDIX operation.

Setting Up PC2AUDIX Interface in a
New Work Area
To set up PC2AUDIX in a new work area on your PC, you must perform three
tasks:
1. Create PC2AUDIX subdirectories.
2. Establish PC2AUDIX Setup Parameters.
3. Establish Setup Parameters for Call Detail Recording (CDR).
Each of these tasks is described in this section.

Creating PC2AUDIX Subdirectories
PC2AUDIX works only in a subdirectory. Before using the interface, you must
create a subdirectory on your PC to serve as a work area for storing retrieved
data.
If you want to retrieve data from more than one voice mail system, you must first
create a separate subdirectory on your PC corresponding to each system. To do
this, perform the following steps:
1. Use the MS-DOS Date and Time commands to verify that the date and
time are correct on your PC.
2. At the DOS prompt, enter cd \ to ensure that you are in your PC’s root
directory (drive C:). You should see the C> prompt displayed. (If you are
using an alternate drive, such as drive D, you should see that drive letter
displayed.)
3. Enter mkdir machine_name (where machine_name is the name of your
voice mail system) to create a PC2AUDIX subdirectory for your system.
If you have more than one voice mail system in an your network, repeat step 3 for
each system.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

3-4

Establishing PC2AUDIX Setup Parameters
Setup parameters define the link between your PC and the voice mail system
from which your PC retrieves data. If you created subdirectories for more than
one system in the previous task, you must also establish separate setup
parameters for each system.
1. At the DOS prompt C>, enter cd machine_name to change to the AUDIX
system subdirectory you created in the previous task. (If you are using an
alternate disk drive, such as drive D:, that drive letter should be
displayed.)
2. Enter pc2audix to call the PC2AUDIX software. Copyright information
appears on the screen for approximately five seconds. If you want to
bypass this delay, press RETURN .
The PC2AUDIX software checks to see that you are currently in a
subdirectory, that no database structures are missing, and that the
database structures are a version prior to ADAP R1V8.
3. If subscriber data exists, a (re)indexing message appears
The PC2AUDIX Setup Parameters screen appears.
4. Position the cursor (using either RETURN or the down arrow key) at each of
the fields that are empty or that have incorrect default values, and enter
the correct values. Field descriptions and valid entries are shown below.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

Field Name

Description

Valid Entries

Type of
connection

Connection type.

att4000 (ATT4000 modem)

Default: direct

direct (hardwired connection using NULL
modem)

3-5

hayes (Hayes-compatible modem)
pdm (Modular Processor Data Module
(MPDM) in conjunction with your Lucent
Technologies switch)
Initialization String

Initialization string
for automatic
modem setup
Default: a null
string.

Baud Rate

Sets the
communications
baud rate,
measured in bits
per second (bps),
if the connection
type is set to
anything other than
direct.

< 40 characters.
Spaces are legal in Hayes initialization strings.
You cannot use automatic modem setup with
the Lucent Technologies 7400B data module.
1200, 2400, 4800, or 9600 (for D-r3.2 thru
D-r1.0.)
1200, 4800 (for R1 AUDIX software version)
NOTE:

Your modem must be able to transmit at the
selected bits per second.

Default: 9600
Port Number

Port that connects
your PC to the
voice mail system.
Default: COM1

Access Phone #

Phone number for
your Local
Administration
Terminal.

1 (COM1)
2 (COM2)
Should specify number of the port to which the
null modem, modem, or PDM is connected.
The PC used to access the DEFINITY AUDIX
system must be connected to Port A on the
DEFINITY AUDIX MFB. The PC used to
access the AUDIX system must be connected
to the LAT (Local Administration Terminal) port
on the AUDIX equipment cabinet. You must
enter the phone number if the connection type
is set to anything other than direct.

NOTE:

When using a Hayes Compatible modem, you may input a “t” in
front of the access phone number to access the system more quickly
using touch-tone dialing.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

3-6

Field Name

Description

AUDIX Login
Name

Administrator’s
login ID.

AUDIX Password

Password for
AUDIX Login
Name.

For security purposes, the password does not
appear on the screen after you press F8
(CHANGE/RUN). To make an entry you must
clear out remaining pound signs before
pressing F8 .

AUDIX System
Password

Password of the
DEFINITY AUDIX
system you want to
access.

For security purposes, the password never
appears (hidden by pound [#] signs) on the
screen after you press F8 (CHANGE/RUN). If
the DEFINITY AUDIX system does not have a
system password, place a set of double
quotes (““) in the field. To make an entry you
must clear out remaining pound signs before
pressing F8 .

Password is
required when the
AUDIX login name
is cust.
AUDIX software
version

Version of the voice
mail system
software used on
this system.

Valid Entries

NOTE:

This field must be set correctly in order for
PC2AUDIX to function properly.

Default: D-r3.2
5. Press F8 (CHANGE/RUN) to save the changes you have made to page 1
of the PC2AUDIX Setup Parameters. (You can also wait until you have
made all changes to page 1 and page 2 of this screen before saving.)
ADAP logs into the voice mail system to verify the switch connection type
and logs out again.
If you specified D-r3.2, D-r3.1, D-r3.0, D-r2.0, or D-r1.0 as the AUDIX
software version, PC2AUDIX displays a message stating that you cannot
revert to an R1 environment for the PC2AUDIX.
6. Press

F6

(NEXT PG) to display page 2 of this screen.

7. Enter the desired information. Field descriptions and valid entries are
shown below the screen example.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

Field Name

Description

Valid Entries

Printer Port

The port on the PC
which connects the
local printer.

lpt1, lpt2, lpt3, com2

Default: lpt1

Printer Type

Indicates that there
is a printer
connected.

3-7

none (no printer connected; output is
displayed automatically on the PC screen).
You may redirect the printed output from lpt1
to a serial port, COMn, using the DOS mode
command. If you use the mode command,
enter lpt1 in the Printer port field.
dotmatrix
(formats output for a 100-percent Epson
compatible dot matrix printer)
laser
(formats output printing for a Hewlett-Packard
LaserJet II or printer capable of 100 percent
emulation of a Hewlett-Packard LaserJet II
blank (no printer connected)
If the previous field is none, enter a blank.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

Field Name

Description

Valid Entries

AUDIX name for
this site

Name of the voice
mail system, your
company, or other
identifier which
appears in the
header information
of reports
generated by
PC2AUDIX.

display-only field

Switch
connection type

Identifies the type
of connection
between the switch
and the voice mail
system.

display-only field

A default (dciu-sci)
initially displays;
this is verified and
changed (if
appropriate) when
the PC connects to
the system.
Delete delimited
data files after
merged by
PC2AUDIX?

Determines if
intermediate data
files received from
the voice mail
system are deleted
from the PC.

3-8

dciu-sci, smsi, bri-api, sl1, sail, or stand-alone
For a DEFINITY AUDIX system, the connection
type in this field comes from the
System-Parameters Features form, and the
value is embedded.
For the AUDIX system, the connection type in
this field comes from the System : Translation :
Switch Connection screen.

y (avoids unnecessary space usage on the
PC)
n (you must manually delete these files when
they are no longer needed)

Default: y
AUDIX misc field
= organization #?:

Interprets
organization codes
Default: n

y ( PC2AUDIX interprets org. codes from the
Miscellaneous field on the DEFINITY AUDIX
Subscriber screen or from the Misc field on
the AUDIX Subscriber : Local screen).
n (org. codes are interpreted from PC2AUDIX
site specific data fields).

Graph Option
Installed?:

Defines whether
optional graphics
software is
installed.

y (Stella Business Graphics package is
installed on this PC)
n (Stella not installed)

Default: n
Location of
Graphics Work
Area

Graphics work
area location.

Directory path for the directory in which the
Stella Business Graphics Package was
installed.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

3-9

8. If you have the optional AUDIX Call Detail Recording (CDR) package
installed on the AUDIX system, you can continue with page 3 of the
PC2AUDIX setup Parameters. Refer to "Establishing Setup Parameters for
Call Detail Recording (Optional)" on the next page.
9. Press F8 (CHANGE/RUN) to save the changes you have made to the
PC2AUDIX Setup Parameters.
You have now completed establishing the PC2AUDIX Setup Parameters.
10. Press

F9

(ROOT FORM) to return to the PC2AUDIX Root Menu.

11. At the PC2AUDIX Root Menu, select 9) EXIT to MS-DOS.
12. At the DOS prompt, enter cd \
on your PC.

RETURN

to return to the root directory (C\>)

NOTE:
If you have more than one voice mail system in an your network,
repeat this task for each system.

Establishing Setup Parameters for Call Detail
Recording (Optional)
Perform the following steps if you have the optional AUDIX Call Detail Recording
(CDR) package installed on the AUDIX system. The Lucent INTUITY and DEFINITY
AUDIX systems do not support this package.
1. At the DOS prompt C>, enter cd machine_name to change to the
subdirectory you created for your AUDIX system in the previous task.
2. Enter pc2audix to call the PC2AUDIX software.
Copyright information appears on the screen for approximately five
seconds. If you want to bypass this delay, press RETURN .
3. In the PC2AUDIX Root Menu, select option 8 (Setup Parameters).
4. In page 1 of the PC2AUDIX Setup Parameters screen, press
PG) to display page 2.

F6

(NEXT

5. In page 2 of the PC2AUDIX Setup Parameters screen, press
PG) again to display page 3.

F6

(NEXT

Page 3 of the PC2AUDIX Setup Parameters defines the connection and
login specifics for retrieving CDR data from the AUDIX system to the PC.
Refer to AUDIX Call Detail Recording Package, 585-305-506, for
instructions on completing this page of the form.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Using PC2AUDIX Application Programs
Setting Up PC2AUDIX Interface in a New Work Area

Issue 14
May 1999
3-10

6. To use the automatic modem setup, enter an Initialization String of up to 40
characters; the default is a null string. Spaces are legal in Hayes
initialization strings. You cannot use automatic modem setup with the
Lucent Technologies 7400B data module. The get_cdr command uses
this initialization string when the -I option is specified.

7. When you have correctly set all values for Call Detail Recording, press
(CHANGE/RUN) to save your changes.
8. Press

F9

F8

(ROOT FORM) to return to the PC2AUDIX Root Menu.

9. At the PC2AUDIX Root Menu, select option 9) EXIT to MS-DOS.
10. At the DOS prompt, enter cd \ to return to the root directory (C:\>) on your
PC.
If you have the Call Detail Recording option installed on more than one AUDIX
system in an AUDIX network, repeat this task for each AUDIX system with CDR.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Modifying PC2AUDIX Setup Parameters

3-11

Modifying PC2AUDIX Setup
Parameters
Perform the following steps to change the PC2AUDIX Setup Parameters.
1. At the DOS prompt C>, enter cd machine_name to change to the
subdirectory for this voice mail system.
2. Enter pc2audix to call the PC2AUDIX software.
3. In the PC2AUDIX Root Menu, select option 8 (Setup Parameters).
4. Enter any changes to the data fields on page 1, page 2, and/or page 3.
5. Press

F8

(CHANGE/RUN) to save the changes.

6. Press

F9

(ROOT FORM) to return to the PC2AUDIX Root Menu.

7. Select 9) EXIT to MS-DOS.
8. At the DOS prompt, enter cd \ to return to the root directory (C:\).
If you need to make changes for other voice mail systems in your network, repeat
this task for each system.

Setting Up PC2AUDIX Interface in an
Existing Work Area
Follow the instructions in this section each time you set up PC2AUDIX in an
existing work area on your PC. If you are upgrading from a previous version of
the ADAP software, you can save any data that you had retrieved using the
previous version.
1. At the DOS prompt C>, enter cd machine_name to change to the
subdirectory where your database structures and text files reside. These
are the database structures and text files you want to upgrade to the new
version of the PC2AUDIX software.
2. Enter pc2audix to call the PC2AUDIX software.
The PC2AUDIX Root Menu appears.
3. Select option 8 from the PC2AUDIX Root Menu to display the PC2AUDIX
Setup Parameters screen.
4. In the PC2AUDIX Setup Parameters screen, change the AUDIX software
version to D-r3.2. If this field is set incorrectly, the software does not
function properly.
5. Press F8 (CHANGE/RUN) to save the changes. ADAP tries to log into the
voice mail system to verify the switch connection type, then logs out again.
6. Press

F9

(ROOT FORM) to return to the PC2AUDIX Root Menu.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Using PC2AUDIX Application Programs
Starting the PC2AUDIX Interface

Issue 14
May 1999
3-12

Starting the PC2AUDIX Interface
The following steps describe how to start PC2AUDIX.
1. At the DOS C> prompt, enter cd machine_name where machine_name
is the name of the subdirectory you set up to represent the voice mail
system. You run PC2AUDIX from this subdirectory.
2. Enter pc2audix at the DOS prompt.
The PC2AUDIX Root Menu appears.

3. Select options from the PC2AUDIX Root Menu as described in the next
section.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
PC2AUDIX Root Menu Options

3-13

PC2AUDIX Root Menu Options
The PC2AUDIX Root Menu provides access to all PC2AUDIX functions. These
options are as follows:

Menu Option

Menu/Screen it Accesses

For More Info.

0) Run Scheduled
Events

Schedule Mode screen, which
must display before scheduled
events begin and during
scheduled event execution.

Chapter 8,
"Scheduling
PC2AUDIX Data
Retrieval"

1) Data Retrieval

Data Retrieval Menu, used to
retrieve and verify the PC2AUDIX
data needed before generating
traffic and billing reports or
performing data searches.

Chapter 4,
"PC2AUDIX Data
Retrieval"

2) Traffic Reports

Traffic Reports Menu, used to
generate reports from traffic and
subscriber information previously
retrieved to the PC (excluding
system attendant reports).

Chapter 5,
"PC2AUDIX
Traffic Reports"

3) Customer Billing

Customer Billing Menu, used to
define customer billing criteria and
to generate billing reports from
retrieved subscriber information.

Chapter 6,
"PC2AUDIX Billing
Reports"

4) Site Specific
Data

Non-AUDIX Data Field
Specification Menu, used to:

Chapter 9,
"PC2AUDIX Site
Specific Data"

1) enter data into non-AUDIX fields
in subscriber records on the PC
2) search for subscribers with
specific data in specified fields
3) list all subscribers;
4) list subscribers with specific
data in specified fields
5) modify names and extensions
directly in the DEFINITY AUDIX or
R1 AUDIX database.
5) Schedule Editor

Scheduling Menu, used to
schedule data retrieval and
database verification, executed
automatically from a queue at
specified times.

Chapter 8,
"Scheduling
PC2AUDIX Data
Retrieval"

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
PC2AUDIX Root Menu Options

3-14

Menu Option

Menu/Screen it Accesses

For More Info.

6) Searches

Searches Menu, used to search for
and list:

Chapter 7,
"PC2AUDIX
Database
Searches"

1) subscribers with system usage
over or under a specified amount
2) subscribers with bills over a
specified amount
3) subscribers with mailbox space
over a specified threshold.
7) Data
Management

Data Management Options Menu,
used to perform the following on
the fixed disk of your PC:
1) back up selected traffic and
subscriber data to a diskette

Chapter 10,
"PC2AUDIX
Database
Management
Tools"

2) delete selected data
3) restore selected data from a
diskette.
8) Setup
Parameters

PC2AUDIX Setup Parameters
Menu, used to:
1) define the connection between
the PC and the voice mail system

Described
previously in this
chapter.

2) enable the graphical output
option
3) define the connection to the R1
AUDIX system for the optional Call
Detail Recording (CDR) feature.
9) EXIT to MS-DOS

Exits you from PC2AUDIX to DOS
and terminates the DEFINITY
AUDIX or AUDIX system
connection, if any. Use this
selection to end a PC2AUDIX
interface session.

N/A

NOTE:
To execute a DOS command from the PC2AUDIX Root
Menu without quitting the PC2AUDIX interface, press
ESC , press s for suspend, and type the exclamation
mark character (!) followed by a command. To return to
PC2AUDIX, type resume, and press the desired key
from the PC2AUDIX Root Menu.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Using On-line Help Files

3-15

Using On-line Help Files
The PC2AUDIX help files provide detailed information about PC2AUDIX screens,
field definitions, function key definitions, and error messages. To display this
information at any time, press F10 (HELP). Information about the current screen
appears. The help screens have several function keys that let you print the
screen, page forward or backward, access general information on operating
help, and exiting help.
You can print a copy of the complete on-line help files to retain as a reference:
1. At the C> prompt, enter audhelp printdoc >myfile where myfile is a file
name of your choosing that does not reside already on your fixed disk.
This copies a formatted ASCII version of the PC2AUDIX help information
to a file named myfile on your fixed disk.
2. Print the file myfile as you would any text file.
You can also print the help files from PC2AUDIX by pressing F10 (HELP) and
then pressing F6 (PRINT ALL). The printed help files are quite long.

Directing PC2AUDIX Output
All screens that generate output contain a “Send output” line that specifies an
output destination. The default destination is set in the Setup Parameters screen.
If you define a printer type and port, the default destination is the specified
printer. If you don’t define a printer, the output is displayed on the screen by
default.

Redirecting Output to the Screen
To display output on the screen, press Ctrl-y while the cursor is in the destination
field, or blank out the printer variable. The output displays on your PC screen.
By sending reports to the PC screen, you can preview them and optionally send
a copy to the printer. You can print from the PC screen if a printer is defined on
the Setup Parameters screen and you override the default manually for individual
reports you produce.
When you display a report on the screen, you can scroll through the displayed
report using function keys defined at the bottom of the screen. You can also use
function keys to print all or part of the data you are viewing.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Using PC2AUDIX Application Programs
Interrupting the PC2AUDIX Interface

Issue 14
May 1999
3-16

Redirecting Output to a File
For each screen report you generate, you can override the default and send the
output to a file on your PC by entering a file name; the output is stored in a file
with that name. The file contains all the control characters needed for printing, so
that you can later generate a printout by sending the file to the printer.

Using Graphical Output
You can graphically format for PC2AUDIX traffic reports (such as bar charts and
line charts) if you have the Stella Business Graphics package on your PC and
you so identified it in the PC2AUDIX Setup Parameters screen. If the graphics
software is not present, the data is presented in table format. When graphical
output is available, screens with graphic output capability prompt you to specify
if you want output displayed graphically for the report.

Interrupting the PC2AUDIX Interface
Depending on the state of PC2AUDIX, there are two ways to interrupt PC2AUDIX.
Only use these techniques if you must gain control quickly. It is safer to allow
normal program operation.
■

If PC2AUDIX is retrieving data from the voice mail system, halt the data
retrieval by typing Ctrl-c (hold down the CONTROL key and the C key at the
same time).

■

If PC2AUDIX is not retrieving data, press the ESC key to return to the
PC2AUDIX Root Menu, then type A. At the Root Menu, you can select
option 9 to terminate PC2AUDIX. You can select exit PC2AUDIX
temporarily from the Root Menu without breaking the connection to the
voice mail system by pressing the exclamation point (!) key.
To execute a DOS command from the PC2AUDIX Root Menu press ESC ,
press s for suspend, and type the exclamation mark character (!)
followed by a command. To return to PC2AUDIX, type resume, and press
the desired key from the PC2AUDIX Root Menu.
If you accidentally press the ESC key, type I to ignore the escape
command and return to the procedure that was executing.

While the field edit mode is active on any of the forms, the ESC key has no effect.
(Field edit mode is active when the cursor is inside an inverse video field on the
screen.) Use one of the screen exit choices — F9 (ROOT FORM) or F7 (PREV
FORM) — to exit while the field edit mode is active.
Do not use the ESC key indiscriminately, because it usually leaves temporary files
in the work area.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Issue 14
May 1999

Using PC2AUDIX Application Programs
Managing PC2AUDIX Data

3-17

Managing PC2AUDIX Data
Now that you have PC2AUDIX up and running and are familiar with its basic
operation and capabilities, let’s discuss how you might use this tool in your
organization.
In time, your PC2AUDIX activities should be fairly cyclical in nature. First you
retrieve the data, then you generate reports, then you delete old data or archive it
on a diskette. For best results, these tasks should become part of your regular
system administration routine that you perform at the same time each week and
month, depending on the activity.

Scheduling PC2AUDIX Processes
After some trial and error, you can establish a schedule for performing
PC2AUDIX tasks. For example, if you plan to use the billing reports, you need to
establish a schedule for regularly retrieving billing data from the voice mail
database and then running the billing reports at the same time each month. The
same is true for traffic reports, where you need the same types of data each week
or month to generate reports for meaningful and accurate comparisons from one
reporting period to another.
NOTE:
The voice mail system does not store traffic and subscriber data
indefinitely. You must retrieve data from the voice mail database in a timely
fashion, before it is deleted by audits that are run weekly by the voice mail
system. Chapter 4, "PC2AUDIX Data Retrieval", tells you how long the voice
mail system retains the different types of retrievable data.
Since retrieving data can be a lengthy process that ties up your PC, you can use
the PC2AUDIX scheduling option to perform data retrieval during off-hours. This
frees up your PC for other duties during the workday, and automates essential
recurring activities. Refer to Chapter 8, "Scheduling PC2AUDIX Data Retrieval",
for information about the scheduling option.

Deleting PC2AUDIX Data
Remember that your PC does not have infinite storage space. You must
periodically delete retrieved data that you no longer need. Chapter 10,
"PC2AUDIX Database Management Tools", describes how to manage data on
your PC, such as backing up, deleting, and restoring data.

AUDIX Administration and Data Acquisition Package 585-302-502

3

Using PC2AUDIX Application Programs
Managing PC2AUDIX Data

Issue 14
May 1999
3-18

Generating PC2AUDIX Reports
The next seven chapters describe each of PC2AUDIX functions in detail and
provide tips on how you might use them in your organization. These chapters are
organized according to the PC2AUDIX Root Menu.
■

Chapter 4, "PC2AUDIX Data Retrieval"

■

Chapter 5, "PC2AUDIX Traffic Reports"

■

Chapter 6, "PC2AUDIX Billing Reports"

■

Chapter 7, "PC2AUDIX Database Searches"

■

Chapter 8, "Scheduling PC2AUDIX Data Retrieval"

■

Chapter 9, "PC2AUDIX Site Specific Data"

■

Chapter 10, "PC2AUDIX Database Management Tools"

AUDIX Administration and Data Acquisition Package 585-302-502

4

PC2AUDIX Data Retrieval
Overview

PC2AUDIX Data Retrieval

Issue 14
May 1999
4-1

4

Overview
With a few exceptions, PC2AUDIX does not use live data from the voice mail
database for its traffic reports and billing operations. Therefore, before you can
generate PC2AUDIX traffic reports or perform billing operations, you must
capture appropriate data from the voice mail and download it to disk files on your
PC’s fixed disk.
How effective PC2AUDIX is for your organization depends on how retrieve data.
The PC2AUDIX traffic reports are valuable because they help you compare
aspects of your voice mail system operation over a period of time. This
information helps you spot trends, anticipate problems, and generally manage
your system more effectively.
For these tools to be effective, however, you must produce reports using the
same types of data for similar periods of time. If a report for one week contains
five days’ worth of data and the same report for the next week contains only three
days’ worth of data, comparing the two reports is of little value.
Similarly, the voice mail system billing operations can be accurate and useful
only if all appropriate data is reflected in their calculations. For best results, you
must determine:
■

the types of data you need to retrieve.

■

how frequently you need to retrieve this data.

■

how long you need to retain it.

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Prerequisites

4-2

Once you have done this, then establish a routine for regularly retrieving this data
as part of your normal system administration. Be aware that the voice mail
system does not retain data indefinitely. For example, subscriber daily traffic
information is kept by the voice mail system for eight days and then deleted.
In addition to retrieving data, you must periodically verify the PC2AUDIX
subscribe database on our PC, comparing it to the subscriber database on the
voice mail system. This verification fixes any discrepancies by adding or deleting
subscribers in the PC database to match the live database on the system. You
must perform this step before initially retrieving subscriber traffic data
using PC2AUDIX or no subscriber data will be retrieved. After this initial
verification, you must verify the database if you have added or changed
subscriber records in the voice mail database, otherwise those changes are not
updated in the retrieved data.
There are to two different ways to retrieve and verify data:
■

On demand, by selecting an option from the AUDIX Data Retrieval menu.
This retrieves and verifies data immediately, which means you cannot use
your PC for other purposes until the process is complete. This method can
tie up your PC for several minutes to several hours, depending on how
much data is being retrieved or verified or retrieved, and how busy the
voice mail system is at the time.

■

Scheduled automatically, using the PC2AUDIX scheduling option.
This method allows you to retrieve and verify data when it is more
convenient or when the system traffic is light, such as during off-hours.
This also frees up your PC, and lets you establish a regular schedule for
automatically verifying the PC database and retrieving the information for
generating reports. For best results, you should know how to retrieve data
using the AUDIX Data Retrieval menu before using the scheduling option
described in Chapter 8, "Scheduling PC2AUDIX Data Retrieval".

Prerequisites
Before you can retrieve data from the voice mail system to the PC, you must:
1. Be able to use your PC to connect and communicate with the voice mail
system as described in the previous chapters.
2. Activate traffic collection feature on the DEFINITY AUDIX
System-Parameters Feature screen or on the AUDIX System :
Appearance. Once the collection feature is active, the voice mail system
maintains data to describe the system activity. You must activate the
feature prior to the period for which you wish to retrieve data.
3. ADAP must retrieve collected data from the system in a timely fashion
before it is deleted from the voice mail system by internal audits:

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Prerequisites

4-3

Voice Mail Data Type

PC2AUDIX
Report Type

Retention Time on the
Voice Mail System

Hourly system traffic

feature

192 hours (eight days)

load
network load
special features
community
Daily system traffic data
records

feature

32 days

load
network load
remote messages
special features
community

Monthly system traffic

remote messages

13 months

Daily subscriber traffic

subscriber

eight days

Monthly subscriber traffic

subscriber

13 months

4. There must be sufficient disk space available on your PC for the that data
you retrieve. PC2AUDIX calculates how much space is required for each
operation and does not collect data if there is not enough space available
on your fixed disk. If you have insufficient disk space, refer to Chapter 10,
"PC2AUDIX Database Management Tools", for instructions on backing up
selected retrieved data to a diskette and then deleting that data from your
fixed disk.

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Initiating PC2AUDIX Data Retrieval

4-4

Initiating PC2AUDIX Data Retrieval
Perform the following steps to initiate data retrieval for the PC2AUDIX interface.
1. At the DOS prompt C>, enter cd machine_name to change to the directory
for the voice mail system you want to retrieve data from.
2. Enter pc2audix to call the PC2AUDIX software.
3. At the PC2AUDIX Root Menu, select 1) Data Retrieval.
The AUDIX Data Retrieval menu appears.

This menu displays the data that is available on the PC for report
generation. When you select an option, PC2AUDIX connects to the voice
mail system and retrieves the indicated data.
For each type of data, this screen displays the dates of the oldest data
and most recent data currently stored on your PC. This data may not be
continuous; the displayed dates are simply the oldest and newest dates
for each type. This screen also displays the most recent verification dates
for the local and remote subscriber directories, which should help you
determine if you need to verify the subscriber databases. If data has never
been retrieved or verified, the system creation date of 01/01/70 or 01/70
appears instead of an actual date or month.
4. Select the appropriate option for the type of data you wish to retrieve or
verify.

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Hourly System Traffic Data Retrieval

4-5

Hourly System Traffic Data Retrieval
Hourly System Traffic Records contain hourly information from the voice mail
system for hourly feature, load, community, special features, and network load
reports. The time involved for retrieving these records is minimal.
PC2AUDIX requires hourly system traffic data for the following reports:
■

Average Ports in Use Report

■

Peak Ports in Use Report

■

Hourly Filesystem Usage Report

■

Hourly Feature Statistics Report

■

Hourly Load Statistics Report

■

Hourly Network Load Statistics Report

■

Hourly Special Feature Statistics Report

■

Hourly Community Statistics Report

To retrieve hourly system traffic data:
1. At the AUDIX Data Retrieval menu, select 1) Hourly System Traffic Data.
The following screen appears:

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Daily System Traffic Data Retrieval

4-6

Defaults in the data fields are as follows:
■

Start collection date and time are the last hourly traffic data record
on the PC plus one hour or 191 hours previous to the current time,
whichever is greater.

■

Stop collection date and time is one hour previous to the current
time.

■

Collection range start and stop hours are 8 a.m. to 6 p.m.

2. If you wish, change the default dates and times. Otherwise PC2AUDIX
retrieves the default-specified information.
3. Press

F8

(CHANGE/RUN) to retrieve the data.

Daily System Traffic Data Retrieval
Daily System Traffic Records contain daily information from the voice mail system
for daily feature, load, community, special features, remote messages, and
network load (AUDIX system only) reports. These records remain in the voice
mail database for 32 days, except for remote messages records, which remain
for eight days. The time involved for retrieving these records is minimal.
PC2AUDIX requires daily system traffic data for the following reports:
■

Daily File System Usage Report

■

Daily Session Usage Report

■

Daily Remote Traffic Report

■

Daily Feature Statistics Report

■

Daily Load Statistics Report

■

Daily Network Load Statistics Report

■

Daily Remote Message Statistics Report

■

Daily Special Feature Statistics Report

■

Daily Community Statistics Report

To retrieve daily system traffic data:
1. At the AUDIX Data Retrieval menu, select 2) Daily System Traffic Data.

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Monthly System Traffic Data Retrieval

4-7

The following screen appears:

Defaults in the data fields are as follows:
■

Collection date is the last daily traffic data record on the PC plus
one day or one month previous to the current day, whichever is
greater.

■

Stop collection date is the day prior to the current day.

2. If you wish, change the default collection dates. Otherwise PC2AUDIX
retrieves the default-specified information.
3. Press

F8

(CHANGE/RUN) to retrieve the data.

Monthly System Traffic Data Retrieval
Monthly System Traffic Data records contain monthly information from the voice
mail system for the monthly remote message report. These records remain in the
voice mail database for 13 months. The time involved for retrieving these records
is minimal. PC2AUDIX requires this information for the Monthly Remote Message
Report.
To retrieve monthly system traffic data:
1. At the AUDIX Data Retrieval menu, select 3) Monthly System Traffic Data.

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Monthly Subscriber Traffic Data Retrieval

4-8

The following screen appears:

■

Start collection month is one month after the last month for which
data was collected.

■

Stop collection month is the current month.

2. If you wish, change the default collection months. Otherwise PC2AUDIX
retrieves the default-specified information.
3. Press

F8

(CHANGE/RUN) to retrieve the data.

Monthly Subscriber Traffic Data
Retrieval
Monthly Subscriber Traffic Data records contain monthly information from the
voice mail system for the monthly subscriber report. You can collect only one
month of data at a time. The time involved for this data collection can be lengthy,
from one to three hours, depending on the number of subscribers on your system
and the system traffic load while the collection takes place.
PC2AUDIX requires monthly subscriber traffic data for the following reports:
■

Monthly Subscriber Statistics Report

■

Monthly Billing Calculation and Billing Reports

■

Subscriber Usage and Subscriber Space Threshold Reports

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Monthly Subscriber Traffic Data Retrieval

4-9

To retrieve monthly subscriber traffic data:
1. Determine if you need to verify the subscriber database. You must
synchronize the PC2AUDIX subscriber database with the voice mail
database before you retrieve subscriber traffic data. To do this, select 6)
Verify Local Subscriber Directory for local subscribers, described later in
this chapter.
(You must perform this step before retrieving subscriber traffic data initially
using PC2AUDIX or no subscriber data will be retrieved. Thereafter, you
must perform this step if you have added or changed subscriber records
in the voice mail database or those changes will not be updated in the
retrieved data.)
2. At the AUDIX Data Retrieval menu, select 4) Monthly Subscriber Traffic
Data.
The following screen appears:

The default collection month is one month after the last month for which
subscriber data was collected.
3. If you wish, change the default collection month. Otherwise PC2AUDIX
retrieves the default-specified information.
4. Press

F8

(CHANGE/RUN) to retrieve the data.

AUDIX Administration and Data Acquisition Package 585-302-502

4

PC2AUDIX Data Retrieval
Daily Subscriber Traffic Data Retrieval

Issue 14
May 1999
4-10

Daily Subscriber Traffic Data Retrieval
Daily Subscriber Traffic Data records contain daily information from the voice mail
system for the daily subscriber report. These records remain in the voice mail
database for eight days.
You can collect only one day of data at a time. The time involved for this data
collection can be lengthy, from one to three hours, depending on the number of
system subscribers and the system traffic load while the collection takes place.
PC2AUDIX requires daily subscriber traffic data for the Daily Subscriber
Statistics Report and Subscriber Usage Report.
To retrieve daily subscriber traffic data:
1. Determine if you need to verify the subscriber database. You must
synchronize the PC2AUDIX subscriber database with the voice mail
database before you can retrieve subscriber traffic data. To do this, select
6) Verify Local Subscriber Directory) for local subscribers, described later
in this chapter.
(You must perform this step before retrieving subscriber traffic data initially
using PC2AUDIX or no subscriber data will be retrieved. After this initial
retrieval and verification, you must perform this step if you have added or
changed subscriber records in the voice mail database, otherwise those
changes will not be updated in the retrieved data.)
2. At the AUDIX Data Retrieval menu, select 5) Daily Subscriber Traffic Data).
The following screen appears:

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Local Subscriber Directory Verification

4-11

It is possible to modify the collection date and leave a gap where no data
has been collected. You can also recollect traffic data over existing data.
The default collection date is the last daily subscriber traffic data record
on the PC plus one day, or seven days previous to the current day,
whichever is greater.
3. If you wish, change the default collection date. Otherwise PC2AUDIX
retrieves the default-specified information.
4. Press

F8

(CHANGE/RUN) to retrieve the data.

Local Subscriber Directory Verification
Verifying the local subscriber directory synchronizes the PC2AUDIX database
with the voice mail database for local subscribers. This verification procedure
changes the PC2AUDIX subscriber database to match the voice mail subscriber
database.
This option verifies that the local subscriber directory (user name, extension,
COS, and miscellaneous field) are current between the PC2AUDIX interface and
the voice mail system. All system data available from the DEFINITY AUDIX List
Subscribers screen or from the AUDIX List : Subscriber screen is transferred to
the PC. PC2AUDIX uses this information to generate the master list of
subscribers for all PC2AUDIX transactions.
(You must verify data before retrieving subscriber traffic data initially using
PC2AUDIX or no subscriber data will be retrieved. After that, perform verification
if you have added, changed, or deleted local subscriber records in the voice mail
database. Otherwise those changes will not be updated in the retrieved data.)
The time involved for this function can be lengthy.
To verify the local subscriber directory:
1. At the AUDIX Data Retrieval menu, select 6) Verify Local Subscriber
Directory).

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Local Subscriber Directory Verification

4-12

The following screen appears:

The results of this comparison are sent to the output device that you
specify, by default the printer defined in the PC2AUDIX Setup Parameters.
You can display the report on the PC screen by blanking out the field, or
copy the report to a file by entering a file name. If PC2AUDIX Setup
Parameters does not define a printer, the report appears on your PC
screen.
2. If you wish, change the default output device. Otherwise PC2AUDIX
retrieves the default-specified information.
3. Press

F8

(CHANGE/RUN) to begin verification.

The output indicates either no difference between the PC2AUDIX system
and the voice mail system, or one of the following differences:

New subscribers

New local subscribers added to the PC2AUDIX database

Deleted
subscribers

Local subscribers in the PC2AUDIX database but not found in the
voice mail database are deleted from the PC2AUDIX database.
The deleted subscribers are listed.
The PC2AUDIX interface keys exclusively from the extension field.
If you change a subscriber’s extension on the voice mail system,
PC2AUDIX will treat this as a delete of this subscriber followed by
an add of a new subscriber.

Modified data
fields

If the Name, cos, or Misc (organization code) fields differ between
the voice mail system and PC2AUDIX, PC2AUDIX uses the new
value and lists the names of local subscribers with data field
changes.

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Remote Subscriber Directory Verification

4-13

Remote Subscriber Directory
Verification
Verifying the remote subscriber directory synchronizes the PC2AUDIX database
with the voice mail database for all remote subscribers. This verification changes
the PC2AUDIX subscriber database to match the voice mail database.
This option verifies that the remote subscriber directory (user name and
extension) are current between PC2AUDIX and the voice mail system. All system
data available from the DEFINITY AUDIX List Remote-Extensions screen or the
AUDIX List : Extension screen is transferred to the PC. The PC2AUDIX interface
uses this information to generate the master list of all remote subscribers in the
network.
The time involved for this function can be lengthy, up to one hour for 3000
subscribers if run while traffic is light on your system.
To verify the remote subscriber directory:
1. At the AUDIX Data Retrieval menu, select 7) Verify Remote Subscriber
Directory.
The following screen appears:

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Call Detail Recording (CDR) Data Retrieval

4-14

The results of this comparison are sent to the output device that you
specify, by default the printer defined in the PC2AUDIX Setup Parameters.
You can display the report on the PC screen by blanking out the field, or
copy the report to a file by entering a file name. If PC2AUDIX Setup
Parameters does not define a printer, the report appears on your PC
screen.
2. If you wish, change the default output device. Otherwise PC2AUDIX
retrieves the default-specified information.
3. Press

F8

(CHANGE/RUN) to begin verification.

PC2AUDIX verifies the database and sends to the specified output
device. The output indicates either that the PC2AUDIX and the voice mail
system databases are identical, or one of the following differences:

New subscribers

Lists new remote subscribers added to the PC2AUDIX database

Deleted subscribers

Deletes remote subscribers in the PC2AUDIX database but not
found in the voice mail database from the PC2AUDIX database.
Lists the deleted subscribers.
The PC2AUDIX interface keys exclusively from the extension field.
If you change a subscriber’s extension on the voice mail system,
PC2AUDIX will treat this as a delete of this subscriber followed by
an add of a new subscriber.

Modified data fields

If the name, type, or date fields differ between the voice mail
system and PC2AUDIX, PC2AUDIX uses the new value and lists
the names of remote subscribers with data field changes.

Call Detail Recording (CDR) Data
Retrieval
To retrieve Call Detail Recording (CDR) data, select 8) Call Detail Recording
(CDR) Data from the AUDIX Data Retrieval menu. This option only works if the
optional AUDIX Call Detail Recording package is installed. Refer to AUDIX Call
Detail Recording Package, 585-305-506, for information about retrieving CDR
data using the PC2AUDIX interface. The Call Detail Recording package is not
available for the INTUITY or DEFINITY AUDIX systems.

AUDIX Administration and Data Acquisition Package 585-302-502

4

Issue 14
May 1999

PC2AUDIX Data Retrieval
Performance Statistics Data Retrieval

4-15

Performance Statistics Data Retrieval
Performance statistics collect raw data from:
■

the voice mail database processor (DBP)

■

the feature processor (FP)

■

the voice session processor (VSP)

You can retrieve these statistics using the PC2AUDIX scheduling option
(described in Chapter 8, "Scheduling PC2AUDIX Data Retrieval" or with the
ADAP command line language getperf command (described in Chapter 11,
"Using the ADAP Command Line Language"). PC2AUDIX does not provide a
reporting structure for this information.
With the scheduling option, you can collect performance statistics automatically
every day on an hourly basis or one time for each scheduled event, depending
on how you set up the scheduler.

AUDIX Administration and Data Acquisition Package 585-302-502

4

PC2AUDIX Data Retrieval
Performance Statistics Data Retrieval

Issue 14
May 1999
4-16

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Overview

PC2AUDIX Traffic Reports

5-1

5

Overview
Using voice mail traffic data that has been retrieved to the PC, PC2AUDIX can
generate the following traffic reports:
■

Average Port Usage Report — Average number of ports in use for
specified hours for each specified day.

■

Peak Port Usage Report — Maximum number of ports in use during the
hour for specified hours on each specified day.

■

Hourly File System Usage Report — Amount of free and used filesystem
space (in blocks) for each hour in a specified day.

■

Daily File System Usage Report — Amount of free and used filesystem
space (in blocks) for each day in a specified range of days.

■

Session Usage Traffic Report — Number of voice mail calls, voice mail
messages, call answer calls, call answer messages, and the total call time
(in seconds) for each day specified. This report also shows the total
number of subscribers on your system as of the last day in the reporting
period.

■

Voice Mail Traffic Data Reports — Retrieved data in the format used by
each of the voice mail traffic forms.

■

Remote Traffic Report — Amount of connect time and the number of
messages sent and received for a particular remote system for each day
in a specified range of days.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Prerequisites

Issue 14
May 1999
5-2

■

Daily System Attendant Traffic Report — Total calls and total prime and
non-prime calls for a main automated attendant and its subattendants for
a specified day. The report is generated using live data in the voice mail
database.

■

Monthly System Attendant Traffic Report — Total calls and total prime and
non-prime calls for a main automated attendant and its subattendants for
a specified day. This report is generated using live data in the voice mail
database.

Prerequisites
Except for the system attendant traffic reports, which use live data in the voice
mail database, you must retrieve data from the system to the PC before
producing reports described in this chapter. Refer to Chapter 4, "PC2AUDIX
Data Retrieval", or Chapter 8, "Scheduling PC2AUDIX Data Retrieval", for
instructions on downloading data from the voice mail system to the PC.
Graphical presentations are available for PC2AUDIX traffic reports if you have the
Stella Business Graphics package installed on your PC and you have configured
PC2AUDIX Setup Parameters to recognize this software. Refer to Chapter 2,
"Installation", for information about installing a graphics package and to Chapter
3, "Using PC2AUDIX Application Programs" for information about configuring
PC2AUDIX Setup Parameters to recognize the graphics software.

Producing Traffic Reports
Perform the following steps to produce PC2AUDIX traffic reports.
1. At the DOS prompt C>, enter cd machine_name to change to the directory
for the DEFINITY AUDIX system, or R1 AUDIX system for which you want
traffic reports.
2. Enter pc2audix to call the software for PC2AUDIX.
3. At the PC2AUDIX Root Menu, select 2) Traffic Reports.
The AUDIX Traffic Reports menu appears.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Average Port Usage Report

5-3

4. Select the appropriate option for the traffic report you wish to produce.

Average Port Usage Report
This report displays the average number of ports in use for each hour in a
selected range of hours during a selected range of dates for a maximum of
seven days. You must first retrieve Hourly System Traffic Data, using ADAP.
This report shows you how your subscribers are using the voice mail system, and
when the load is heavy or light. It also shows you trends over time if you save
older copies of this report. These trends might indicate that you need more ports
to support your subscribers or that you can add more subscribers without
adversely affecting performance. (However, remember also to consider whether
you have enough disk space for additional subscribers.)
The following is an example of the Average Port Usage Report in table format:

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Average Port Usage Report

Issue 14
May 1999
5-4

To display the Average Port Usage Report:
1. At the AUDIX Traffic Reports menu, select 1) Average Ports in use by Hour
for a Period.
2. The following screen appears:

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Peak Port Usage Report

5-5

Defaults are as follows:
■

Report Starting Date is the latest Monday for which five days of
traffic data exist on the PC, and the default Report Ending Date is
the latest date for which traffic data exists on the PC. You can
change these dates to any dates in a seven-day period for which
hourly system traffic data exists on the PC.

■

Hours Displayed are the hours for which data exists on the PC
during the range of days represented by the default starting and
ending dates. You can change these hours to include fewer hours
than the displayed range.

■

“Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
blanking out the field, or copy the report to a file by entering a file
name. If you did not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

3. If you wish, change the default report data. Otherwise PC2AUDIX retrieves
the default-specified information.
4. Press F8 (CHANGE/RUN) to generate the report and send it to the
specified output device.
5. If Stella Business Graphics is installed on your PC, the prompt “Do you
want to see the graphical view of this data?” appears. Enter y to include
graphical output or n to display the report in table format only.
6. The report appears as a table with days shown horizontally across the
page and hours listed vertically. If you have graphical output capability
and entered y in the previous step, a chart also is included with the output.

Peak Port Usage Report
This report displays the peak port usage for each hour in a selected range of
hours during a selected range of dates for a maximum of seven days. You must
first retrieve Hourly System Traffic Data for the specified dates on this report,
using PC2AUDIX.
Peak port usage tells you the maximum number of ports that were used during a
particular hour. If your system is configured properly for your actual usage, the
system should peak at the maximum number of ports occasionally. If you never
reach the maximum, you may be able to add more subscribers without worrying
about ports.
The following is an example of the Peak Port Usage Report in table format:

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Peak Port Usage Report

Issue 14
May 1999
5-6

To display the Peak Port Usage Report:
1. At the AUDIX Traffic Reports menu, select 2) Peak Ports in use by Hour for
a Period.
The following screen appears:

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Peak Port Usage Report

5-7

Defaults are as follows:
■

Report Starting Date is the latest Monday for which five days of
traffic data exist on the PC, and the default Report Ending Date is
the latest date for which traffic data exists on the PC. You can
change these dates to any dates in a seven-day period for which
hourly system traffic data exists on the PC.

■

Hours Displayed are the hours for which data exists on the PC
during the range of days represented by the default starting and
ending dates. You can change these hours to include fewer hours
than the displayed range.

■

“Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
blanking out the field, or copy the report to a file by entering a file
name. If you did not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

2. If you wish, change the default report data. Otherwise PC2AUDIX retrieves
the default-specified information.
3. Press F8 (CHANGE/RUN) to generate the report and send it to the
specified output device.
4. If you have Stella Business Graphics installed on your PC, the prompt “Do
you want to see the graphical view of this data?” appears. Enter y to
include graphical output or n to display the report in table format only.
5. The report appears as a table with days shown horizontally across the
page and hours listed vertically. If you have graphical output capability
and entered y in the previous step, a chart also is included with the output.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Hourly File System Usage Report

5-8

Hourly File System Usage Report
This report displays the number of blocks of voice text space used and available
for each hour during a specified day. You must first retrieve Hourly System Traffic
Data for this report for the specified date, using PC2AUDIX.
This report shows you how your subscribers use message space during the day.
For example, you may see the used space increasing in the morning when
employees are in meetings, then decrease at lunchtime when messages are
picked up and deleted, increase again in the afternoon, and decrease again at
the end of the day.
The following is an example of the Hourly File System Report in table format:

Data fields in this report provide the following information:
■

FREE SPACE
The total amount of space (measured in blocks) allocated for, but not used
by, voice text filesystems.

■

USED SPACE
The total amount of space (measured in blocks) used by voice text
filesystems.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Hourly File System Usage Report

5-9

To display the Hourly File System Report:
1. At the AUDIX Traffic Reports menu, select 3) Hourly File System Usage for
a Day.
The following screen appears:

Defaults are as follows:
■

Report for Day is the latest date for which hourly system traffic data
exists on the PC. You can change this date to any date for which
hourly system traffic data exists on the PC.

■

“Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
blanking out the field, or copy the report to a file by entering a file
name. If you did not define a printer PC2AUDIX Setup Parameters,
this field is blank by default and the report appears on the PC
screen.

2. If you wish, change the default report data. Otherwise PC2AUDIX retrieves
the default-specified information.
3. Press F8 (CHANGE/RUN) to generate the report and send it to the
specified output device.
4. If you have Stella Business Graphics installed on your PC, the prompt “Do
you want to see the graphical view of this data?” appears. Enter y to
include graphical output or n to display the report in table format only.
5. The report appears as a table with free space and used space shown
horizontally across the page and hours listed vertically. If you have
graphical output capability and entered y in the previous step, a chart also
is included with the output.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Daily File System Usage Report

5-10

Daily File System Usage Report
This report displays the total number of blocks of voice text space used and
available for each day in a range of days (up to 50 days). You must first retrieve
Daily System Traffic Data for this report for the specified dates, using PC2AUDIX.
This report shows you how your system’s message space is being used. When a
system is first installed, the trend is upward (filesystem usage keeps increasing).
Also, when you add new subscribers, normally you see an upward trend. If, once
your system is stable, you still see an upward trend, try to estimate when you may
need more message space. Analyzing filesystem space also lets you know when
you can add more subscribers without degrading system performance
(remember to check your average port usage as well).
If your disk(s) are fully allocated, you should print this report often to see if you
need to order a new disk. (The DEFINITY AUDIX system accommodates only one
disk, but you may need to order a larger disk.) Remember, it takes a few weeks
to place the order and get the new disk, so this report helps you to anticipate
when you might need to increase your capacity.
The following is an example of the Daily File System Usage Report in table
format:

Data fields in this report provide the following information:
■

FREE SPACE
The total amount of space (measured in blocks) allocated for, but not
used, by voice text filesystems.

■

USED SPACE
The total amount of space (measured in blocks) used by voice text
filesystems.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Daily File System Usage Report

5-11

To display the Daily File System Report:
1. At the AUDIX Traffic Reports menu, select 4) Daily File System Usage for a
Period.
The following screen appears:

Defaults are as follows:
■

Report Starting Date is the latest Monday for which five days of
traffic data exist on the PC. The Report Ending Date is the latest
date for which daily system traffic data exists on the PC. You can
change these dates to any dates in a 50-day period for which daily
system traffic data exists on the PC.

■

“Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
making the field blank, or copy the report to a file by entering a file
name. If you did not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

2. If you wish, change the default report data. Otherwise PC2AUDIX retrieves
the default-specified information.
3. Press F8 (CHANGE/RUN) to generate the report and send it to the
specified output device.
4. If you have Stella Business Graphics installed on your PC, the prompt “Do
you want to see the graphical view of this data?” appears. Enter y to
include graphical output or n to display the report in table format only.
5. The report appears as a table with free space and used space shown
horizontally across the page and days listed vertically. If you have
graphical output capability and entered y in the previous step, a chart also
is included with the output.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Session Usage Traffic Report

5-12

Session Usage Traffic Report
This report displays the total number of the following per day:
■

Voice mail calls

■

Voice mail messages created

■

Call answer calls

■

Call answer messages left

■

Total connect time for all ports (in seconds divided by 100) for each
specified day in a range of days (up to 40 days)

The report also shows the number of subscribers administered on the voice mail
system as of the last date in the reports. You must first retrieve Daily System
Traffic Data for the specified dates on this report, using PC2AUDIX.
This report shows you how your subscribers are using the voice mail and call
answer features:
■

Are subscribers recording voice mail messages? If not, should you set up
a class to teach them the benefits of using voice mail?

■

For the number of call answer calls, how many messages are left? Fifty
percent is an industry average. If the number is very low, is there a
reason? Perhaps personal greetings are not friendly enough, or fail to
invite the caller to leave a message. Perhaps subscribers use a covering
extension.

■

Are the number of voice mail messages keeping up with the number of
call answer messages? This is one indication of how responsive your
subscribers are.

The following is an example of the Session Usage Traffic Report in table format:

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Session Usage Traffic Report

5-13

Data fields in this report provide the following information:

Total Subscribers

Total number of subscribers administered on the voice
mail system as of the last day of the report.

VM CALLS

Total number of voice mail calls placed during the day.

VM MSGS

Total number of voice mail messages created.

CA CALLS

Total number of call answer calls.

CA MSGS

Total number of call answer messages that were left.

CCS

Total connect time for all ports, measured in hundred
(centum) call seconds (total seconds divided by 100).

To display the Session Usage Traffic Report:
1. At the AUDIX Traffic Reports menu, select 5) Session Usage per Day for a
Period.
The following screen appears:

Displayed defaults are as follows:
■

Default Report Starting Date is the latest Monday for which five
days of traffic data exist on the PC, and the Report Ending Date is
the latest date for which daily system traffic data exists on the PC.
You can change these dates to any dates in a 40-day period for
which daily system traffic data exists on the PC.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports
■

5-14

The “Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
blanking out the field, or copy the report to a file by entering a file
name. If you did not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

2. If you wish, change the default report data. Otherwise PC2AUDIX retrieves
the default-specified information.
3. Press F8 (CHANGE/RUN) to generate the report and send it to the
specified output device.
4. If Stella Business Graphics is installed on your PC, the prompt “Do you
want to see the graphical view of this data?” appears. Enter y to include
graphical output or n to display the report in table format only.
5. The report appears as a table with report fields shown horizontally across
the page and days listed vertically down the page. If you have graphical
output capability and entered y in the previous step, a line chart also is
included with the output.

Traffic Data Reports
The PC2AUDIX View AUDIX Traffic Data option allows you to display downloaded
system and subscriber traffic data in report formats that are similar to the voice
mail traffic forms displayed on the administration terminal. Graphical output via
the Stella Business Graphics package is not available for these reports.
This section describes how to display and manipulate AUDIX Traffic Data reports
with PC2AUDIX. Refer to the following manuals for information about interpreting
these reports and for descriptions of the specific information contained in data
fields on the reports:
■

Refer to Chapter 8, "Scheduling PC2AUDIX Data Retrieval", in DEFINITY
AUDIX System Administration, 585-300-507, or in AUDIX Administration,
585-305-501, for information about interpreting each traffic report.

■

Refer to the traffic forms in DEFINITY AUDIX System Forms Reference,
585-300-207, or in AUDIX Release 1 Version 8 Forms Reference,
585-306-204, for descriptions of the specific information contained in data
fields on each traffic report.

The PC2AUDIX help files also contain summarized information about using and
interpreting these reports.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-15

To Select AUDIX Traffic Data Reports to view:
1. At the AUDIX Traffic Reports menu, select 6) View AUDIX Traffic Data.
The following screen appears:

2. Select the appropriate option for the AUDIX Traffic Data report you wish to
produce. Individual reports are described on the next several pages.
3. These reports display the appropriate traffic data. Occasionally, a traffic
item displays as -1, which means that the particular traffic item is
unavailable.

View Hourly Feature Statistics
The Hourly Feature Statistics Report displays downloaded traffic data in the
same format as the DEFINITY AUDIX List Measurements Feature Hour screen or
the R1 AUDIX traffic : feature : hour screen. You must first retrieve Hourly System
Traffic Data, using PC2AUDIX.
This report includes the following types of information about the DEFINITY AUDIX
or R1 AUDIX system feature usage for a specific hour on a specific date:
■

Average number of ports in use during the busiest hour

■

Voice mail session usage time and the number of successful and
unsuccessful login attempts by internal and external callers

■

Call answer session usage time and the number of completed and
abandoned calls by internal and external callers

■

Number of voice mail messages sent and currently residing on the voice
mail system

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-16

■

Number of broadcast messages, login announcements, priority
messages, and private messages sent and currently residing on the voice
mail system

■

The number of call answer messages sent and currently residing on the
voice mail system

■

The average length and storage time of voice mail and call answer calls

To display the Hourly Feature Statistics Report:
1. At the View AUDIX Traffic Data menu, select 1) Hourly Feature Statistics.
The first page of the report displays data for the latest hour of the latest
date for which hourly system traffic data exists on the PC.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

2. Press

F4

5-17

(NEXT PAGE) to display the second page of report information.

3. Choose from the following:
■

Press

■

Enter a date (and optionally a different hour in the Hour field); and
then press F8 (CHANGE/RUN) to display data for the same hour (or
optionally for a different hour) on that date.

■

With the cursor at the Date field:

F4

(NEXT PAGE) again to redisplay the first report page.

— Press F6 (PREV REC) to display data for the same hour on
the date prior to the displayed date
OR
— Press F8 (CHANGE/RUN) to display data for the same hour
on the next date after the displayed date.
■

Enter an hour (and optionally a different date in the Date field); and
then press F8 (CHANGE/RUN) to display data for that hour on the
same date (or optionally for a different date).

■

With the cursor at the Hour field:
— Press F6 (PREV REC) to display data for the hour prior to the
displayed hour on the same date.
OR
— Press F8 (CHANGE/RUN) to display data for the next hour
after the displayed hour on the same date.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-18

View Daily Feature Statistics
The Daily Feature Statistics Report displays downloaded traffic data in the same
format as the DEFINITY AUDIX List Measurements Feature Day screen or the
R1 AUDIX traffic : feature : day screen. You must first retrieve Daily System Traffic
Data for this report, using PC2AUDIX.
This report includes the same types of information as the Hourly Feature
Statistics Report except information is shown for an entire day instead of for a
specific hour.
To display the Daily Feature Statistics Report:
1. At the View AUDIX Traffic Data menu, select 6) Daily Feature Statistics.
The first page of the report appears with data for the latest date for which
daily system traffic data exists on the PC.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-19

2. Press F4 (NEXT PAGE) to display the second page of information for the
report.

3. Choose from the following:
■

Press F4 (NEXT PAGE) again to redisplay the first page of the
report.

■

Enter a date, then press
date.

■

With the cursor at the Date field, press F6 (PREV REC) to display
data for the date prior to the displayed date.

■

With the cursor at the Date field, press F8 (CHANGE/RUN) to
display data for the next date after the displayed date.

F8

(CHANGE/RUN) to display data for that

View Hourly Load Statistics
The Hourly Load Statistics Report displays downloaded traffic data in the same
format as the DEFINITY AUDIX List Measurements Load Hour screen or the
R1 AUDIX traffic : load : hour screen. You must first retrieve Hourly System Traffic
Data for this report, using PC2AUDIX.
This report includes the following types of information about the voice mail
system port usage for a specific hour on a specific date:
■

Number of seconds each port handled calls and the number of calls that
were handled

■

Amount of voice text filesystem space used and the amount available

■

Number of subscriber mailbox threshold exceptions and the number of
message deliveries that required rescheduling

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-20

To display the Hourly Load Statistics Report:
1. At the View AUDIX Traffic Data menu, select 2) Hourly Load Statistics.
The report appears with data for the latest hour of the latest date for which
hourly system traffic data exists on the PC.

2. Press

F4

(NEXT PAGE) to display the second page of the report.

3. Press

F4

(NEXT PAGE) again to redisplay the first page of the report.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-21

4. Choose from the following:
■

Enter a date (and optionally a different hour in the Hour field); and
then press F8 (CHANGE/RUN) to display data for the same hour (or
optionally for a different hour) on that date.

■

With the cursor at the Date field:
— Press F6 (PREV REC) to display data for the same hour on
the date prior to the displayed date.
OR
— Press F8 (CHANGE/RUN) to display data for the same hour
on the next date after the displayed date.

■

Enter an hour (and optionally a different date in the Date field); and
then press F8 (CHANGE/RUN) to display data for that hour on the
same date (or optionally for a different date).

■

With the cursor at the Hour field:
— Press F6 (PREV REC) to display data for the hour prior to the
displayed hour on the same date.
OR
— Press F8 (CHANGE/RUN) to display data for next hour after
the displayed hour on the same date.

View Daily Load Statistics
The Daily Load Statistics Report displays downloaded traffic data in the same
format as the DEFINITY AUDIX List Measurements Load Day screen or the
R1 AUDIX traffic : load : day screen. You must first retrieve Daily System Traffic
Data for this report, using PC2AUDIX.
This report includes the same types of information as the Hourly Load Statistics
Report except information is shown for an entire day instead of for a specific
hour.
To display the Daily Load Statistics Report:
1. At the View AUDIX Traffic Data menu, select 7) Daily Load Statistics.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

The report appears with data for the latest date for which daily system
traffic data exists on the PC.

2. Press

F4

(NEXT PAGE) to display the second page of the report.

5-22

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-23

3. Choose from the following:
■

Press F4 (NEXT PAGE) again to redisplay the first page of the
report.

■

Enter a date and press
date.

■

With the cursor at the Date field:

F8

(CHANGE/RUN) to display data for that

— Press F6 (PREV REC) to display data for the date prior to the
displayed date
OR
— Press F8 (CHANGE/RUN) to display data for the next hour
after the displayed hour on the same date.

View Hourly Network Load Statistics
The Hourly Network Load Statistics Report displays downloaded traffic data in
the same format as the R1 AUDIX traffic : network load : hour screen and
DEFINITY AUDIX List Measurements Network Load Hourly screen (beginning
with release 3.2). You must first retrieve Hourly System Traffic Data, using
PC2AUDIX.
This report includes the following types of information about network port usage
on the AUDIX system for a specific hour on a specific date:
■

Maximum number of network data ports that were active at one time, the
number of seconds each port handled incoming and outgoing calls, and
the number of incoming and outgoing calls that were handled by each
port

■

Number of incoming calls that were unanswered, the number of message
transmission threshold exceptions, and the number of limit exceptions that
caused the transmission to cease

■

Number of remote messages that were not deliverable to the remote
system and the number of remote messages that were rescheduled for
delivery

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-24

To display the Hourly Network Load Statistics Report:
1. At the View AUDIX Traffic Data menu, select 3) Hourly Network Load
Statistic.
The report appears with data for the latest hour of the latest date for which
hourly system traffic data exists on the PC.

2. Choose from the following:
■

Enter a date (and optionally a different hour in the hour field); and
then press F8 (CHANGE/RUN) to display data for the same hour (or
optionally for a different hour) on that date.

■

With the cursor at the date field
— Press F6 (PREV REC) to display data for the same hour on
the date prior to the displayed date.
OR
— Press F8 (CHANGE/RUN) to display data for the same hour
on the next date after the displayed date.

■

With the cursor at the hour field, enter an hour (and optionally a
different date in the starting date field); and then press F8
(CHANGE/RUN) to display data for that hour on the same date (or
optionally for a different date).

■

With the cursor at the hour field:
— Press F6 (PREV REC) to display data for the hour prior to the
displayed hour on the same date.
OR
— Press F8 (CHANGE/RUN) to display data for the next hour
after the displayed hour on the same date.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-25

View Daily Network Load Statistics
The Daily Network Load Statistics Report displays downloaded traffic data in the
same format as the R1 AUDIX traffic : network load : day screen and DEFINITY
AUDIX List Measurements Network Load Hourly screen (beginning with release
3.2). You must first retrieve Daily System Traffic Data, using PC2AUDIX.
This report includes the same types of information as the Hourly Network Load
Statistics Report except information is shown for an entire day instead of for a
specific hour.
To display the Daily Network Load Statistics Report:
1. At the View AUDIX Traffic Data menu, select 8) Daily Network Load
Statistics. The report appears with data for the latest date for which daily
system traffic data exists on the PC.

2. Choose from the following:
■

Enter a date and press
date.

■

With the cursor at the date field:

F8

(CHANGE/RUN) to display data for that

— Press F6 (PREV REC) to display data for the date prior to the
displayed date.
OR
— Press F8 (CHANGE/RUN) to display data for the next date
after the displayed date.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-26

View Hourly Special Feature Statistics
The Hourly Special Feature Statistics Report displays downloaded traffic data in
the same format as the DEFINITY AUDIX List Measurements Special-Features
screen or the R1 AUDIX traffic : special features : hour screen. You must first
retrieve Hourly System Traffic Data, using PC2AUDIX.
This report includes the following types of information about the port-dependent
feature usage on a voice mail system for a specific hour on a specific date:
■

The highest number of simultaneous outcalls and the number of outcalls
attempted, completed, and rescheduled

■

The number of calls that were answered without a switch-link “connect”
message.

To display the Hourly Special Feature Statistics Report:
1. At the View AUDIX Traffic Data menu, select 4) Hourly Special Feature
Statistics.
The report appears with data for the latest hour of the latest date for which
hourly system traffic data exists on the PC.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-27

2. Choose from the following:
■

Enter a date (and optionally a different hour in the hour field); and
then press F8 (CHANGE/RUN) to display data for the same hour (or
optionally for a different hour) on that date.

■

With the cursor at the Date field:
— Press F6 (PREV REC) to display data for the same hour on
the date prior to the displayed date
OR
— Press F8 (CHANGE/RUN) to display data for the same hour
on the next date after the displayed date.

■

Enter an hour (and optionally a different date in the Date field); and
then press F8 (CHANGE/RUN) to display data for that hour on the
same date (or optionally for a different date).

■

With the cursor at the Hour field:
— Press F6 (PREV REC) to display data for the hour prior to the
displayed hour on the same date.
OR
— Press F8 (CHANGE/RUN) to display data for the next hour
after the displayed hour on the same date.

View Daily Special Feature Statistics
The Daily Special Feature Statistics Report displays downloaded traffic data in
the same format as the DEFINITY AUDIX List Measurements Special-Features
Day screen or the R1 AUDIX traffic : special features : day screen. You must first
retrieve Daily System Traffic Data for this report, using PC2AUDIX.
This report includes the same types of information as the Hourly Special Feature
Statistics Report except information is shown for an entire day instead of for a
specific hour.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-28

To display the Daily Special Feature Report:
1. At the View AUDIX Traffic Data menu, select A) Daily Special Feature
Statistics.
The report appears with data for the latest date for which daily system
traffic data exists on the PC.

2. Choose from the following:
■

Enter a date and press
date.

■

With the cursor at the Date field, press F6 (PREV REC) to display
data for the date prior to the displayed date, or press F8
(CHANGE/RUN) to display data for the next date after the
displayed date.

F8

(CHANGE/RUN) to display data for that

View Hourly Community Statistics
The Hourly Community Statistics Report displays downloaded traffic data in the
same format as the DEFINITY AUDIX List Measurements Community Hour screen
or the R1 AUDIX traffic : community : hour screen. You must first retrieve Hourly
System Traffic Data for this report, using PC2AUDIX.
This report includes the following types of information about usage of the
sending restriction by community feature on the voice mail system for a specific
hour on a specific date:
■

Number of messages sent and received by each community

■

Number of messages not sent and not received by each community due
to sending restrictions

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-29

To display the Hourly Community Statistics Report:
1. At the View AUDIX Traffic Data menu, select 5) Hourly Community
Statistics.
The report appears with data for the latest hour of the latest date for which
hourly system traffic data exists on the PC.

2. Choose from the following:
■

Enter a date (and optionally a different hour in the Hour field); and
then press F8 (CHANGE/RUN) to display data for the same hour (or
optionally for a different hour) on that date.

■

With the cursor at the Date field, press F6 (PREV REC) to display
data for the same hour on the date prior to the displayed date, or
press F8 (CHANGE/RUN) to display data for the same hour on the
next date after the displayed date.

■

Enter an hour (and optionally a different date in the Date field); and
then press F8 (CHANGE/RUN) to display data for that hour on the
same date (or optionally for a different date).

■

With the cursor at the Hour field, press F6 (PREV REC) to display
data for the hour prior to the displayed hour on the same date, or
press F8 (CHANGE/RUN) to display data for the next hour after the
displayed hour on the same date.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-30

View Daily Community Statistics
The Daily Community Statistics Report displays downloaded traffic data in the
same format as the DEFINITY AUDIX List Measurements Community Day screen
or the R1 AUDIX traffic : community : day screen. This report includes the same
types of information as the Hourly Community Statistics Report except
information is shown for an entire day instead of for a specific hour. You must first
retrieve data you want for this report by using PC2AUDIX.
To display the Daily Community Report:
1. At the View AUDIX Traffic Data menu, select B) Daily Community Statistics.
The report appears with data for the latest date for which daily system traffic data
exists on the PC.

2. Choose from the following:
■

Enter a date and press
date.

■

With the cursor at the Date field:

F8

(CHANGE/RUN) to display data for that

— Press F6 (PREV REC) to display data for the date prior to the
displayed date.
OR
— Press F8 (CHANGE/RUN) to display data for the next date
after the displayed date.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-31

View Daily Remote Message Statistics
The Daily Remote Message Statistics Report displays downloaded traffic data in
the same format as the DEFINITY AUDIX List Measurements Remote-Messages
Day screen or the R1 AUDIX traffic : remote messages : day screen. You must
first retrieve Daily System Traffic Data, using PC2AUDIX.
This report includes the following types of information about message traffic data
for remote systems connected via digital networking, AMIS analog networking, or
Message Delivery.
■

The number of message transfer sessions between the local voice mail
system and the remote machine, the total and average times for these
sessions, and the number of unsuccessful call attempts from the local
voice mail system to the remote system (or telephone)

■

The number of messages that were sent by the local voice mail system to
the remote system, the number of messages that were scheduled for
delivery from the local voice mail system to the remote system but rejected
as undeliverable, and the number of messages sent by the remote system
to the local voice mail system (or telephone)

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-32

To display the Daily Remote Message Report:
1. At the View AUDIX Traffic Data menu, select 9) Daily Remote Message
Statistics.
The report appears as shown below, with data for the first administered remote
system on the latest date for which daily system traffic data exists on the PC.
2. Choose from the following:
■

With the cursor at the Machine Name field, enter a remote system
name (and optionally a different date in the Date field); and then
press F8 (CHANGE/RUN) to display data for that system on the
displayed date.
— With the cursor at the Machine Name field Press F6 (PREV
REC) to display data about the previous remote machine for
the same date.
OR
— Press F8 (CHANGE/RUN) to display data for the next remote
system for the same date.

■

With the cursor at the Date field, enter a date (and optionally a
different remote system in the machine name field); and then press
F8 (CHANGE/RUN) to display data about the remote system for
that date.

■

With the cursor at the Date field:
— Press F6 (PREV REC) to display data for the remote system
for the date prior to the currently displayed date.
OR
— Press F8 (CHANGE/RUN) to display data for the remote
system for the next date after the currently displayed date.

View Monthly Remote Message Statistics
The Monthly Remote Message Statistics Report displays downloaded traffic data
in the same format as the DEFINITY AUDIX List Measurements
Remote-Messages Month screen or the R1 AUDIX traffic : remote messages :
month screen. You must first retrieve Monthly System Traffic Data, using
PC2AUDIX.
This report includes the same types of information as the Daily Remote Message
Statistics Report except information is shown for an entire month instead of for a
specific day.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-33

To display the Monthly Remote Message Report:
1. At the View AUDIX Traffic Data menu, select D) Monthly Remote Message
Statistics.
The report appears with data for the first administered remote system on
the latest month for which monthly system traffic data exists on the PC.

2. Choose from the following:
■

Enter a remote machine name (and optionally a different starting
date in the Date field); and then press F8 (CHANGE/RUN).

■

With the cursor at the Machine Name field:
— Press F6 (PREV REC) to display data about the previous
remote system for the same period.
OR
— Press F8 (CHANGE/RUN) to display data for the next remote
system for the same period.

■

Enter a starting date (and optionally a different remote system in the
Machine Name field); and then press F8 (CHANGE/RUN).

■

With the cursor at the Date field:
— Press F6 (PREV REC) to display data for the remote system
for the month prior to the currently displayed month.
OR
— Press F8 (CHANGE/RUN) to display data for the remote
system for the next month after the currently displayed
month.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Traffic Data Reports

Issue 14
May 1999
5-34

View Daily Subscriber Statistics
The Daily Subscriber Statistics Report displays downloaded subscriber traffic
data in the same format as the DEFINITY AUDIX List Measurements Subscriber
Day screen or the R1 AUDIX traffic : subscriber : day screen. You must first
retrieve data you want to display on this report, using PC2AUDIX.
This report contains three separate pages of data and includes the following
types of information about any individual subscriber on the voice mail system for
a specific date:
■

Subscriber’s community id, total mailbox space used and allowed, the
largest message space used during this day, and the minimum amount of
message space guaranteed for the subscriber’s mailbox

■

Number of times during prime and non-prime hours that call answer
callers were directed to the voice mail system on behalf of the subscriber
and the number of times the subscriber logged into the system

■

Number of voice mail messages received by the subscriber from local and
remote subscribers during prime and non-prime hours

■

Number of undeliverable voice mail notifications received by the
subscriber during prime and non-prime hours indicating that messages
scheduled for delivery by the subscriber were rejected as undeliverable

■

Number of new call answer messages accumulated in the subscriber’s
mailbox during prime and non-prime hours

■

Number of voice mail messages, broadcast messages, log-in
announcements, priority messages, and private messages created by the
subscriber during prime and non-prime hours

■

Number of voice mail messages that were sent by the subscriber to local
and remote subscribers during prime and non-prime hours

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-35

To display the Daily Subscriber Statistics Report:
1. At the View AUDIX Traffic Data menu, select C) Daily Subscriber Statistics.
The first page of the report appears with data for the first subscriber
alphabetically on the latest date for which daily subscriber traffic data
exists on the PC.

2. Press

F3

(NEXT PAGE) to display the second page of information.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-36

3. Press

F3

(NEXT PAGE) again to display the third page of information.

4. Press

F3

(NEXT PAGE) again to redisplay the first page of the report.

5. Enter the name or extension of the subscriber you want to display, and
press F8 (CHANGE/RUN).
Daily traffic data is displayed for the specified subscriber. You can then
select any of the previous options or choose from the following additional
options:
■

Press

■

Press F4 (NX MTCH) to display the next sequential record in the file
with the same name.

■

Press

■

Press F6 (PREV REC) to display the previous sequential record in
the file. If the Name field is highlighted, the previous name appears;
if the Extension field is highlighted, the previous extension appears.

F3

F5

(NEXT PAGE) to display the next subscriber.

(PRINT) to print the subscriber record on your printer.

View Monthly Subscriber Statistics
The Monthly Subscriber Statistics Report displays downloaded subscriber traffic
data in the same format as the DEFINITY AUDIX List Measurements Subscriber
Month screen or the R1 AUDIX traffic : subscriber : month screen. You must first
retrieve Daily Subscriber Traffic Data for this report, using PC2AUDIX.
This report includes the same types of information as the Daily Subscriber
Statistics Report except information is shown for an entire month instead of one
day.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-37

To display the Monthly Subscriber Statistics Report:
1. At the View AUDIX Traffic Data menu, select E) Monthly Subscriber
Statistics.
The first page of the report displays data for the first subscriber
alphabetically in the latest month for which monthly subscriber traffic data
exists on the PC.

2. Press

F3

(NEXT PAGE) to display the second page of information.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Traffic Data Reports

5-38

3. Press

F3

(NEXT PAGE) again to display the third page.

4. Press

F3

(NEXT PAGE) again to redisplay the first page of the report.

5. Enter the name or extension of the subscriber you want to display, and
press F8 (CHANGE/RUN)
Monthly traffic data appears for the specified subscriber. You then can
select any of the previous options or choose from the following additional
options:
■

Press F3 (NEXT PAGE) to display additional pages for the
displayed subscriber.

■

Press F4 (NX MTCH) to display the next sequential record in the file
with the same name.

■

Press

■

Press F6 (PREV REC) to display the previous sequential record in
the file. If the name field is highlighted, the previous name appears;
if the extension field is highlighted, the previous extension appears.

F5

(PRINT) to print the subscriber record on your printer.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Remote Traffic Report

Issue 14
May 1999
5-39

Remote Traffic Report
This report displays the daily connect time (local and remote usage, local
messages sent, and remote messages received) between a voice mail system
and a specified remote system using AMIS Analog Networking or digital AUDIX
networking for each specified day in a range of days (up to 40 days). You must
first retrieve Daily System Traffic Data for the specified dates on this report, using
PC2AUDIX.
This report lets you see the activity between your voice mail system and the
remote systems when using AMIS Analog Networking or an AUDIX network. If
traffic is heavy, you might want to examine how often messages are exchanged
and increase the frequency accordingly. Conversely, if traffic is light, you may
want to reduce the frequency of transmissions, or only allow transmissions during
reduced-cost hours.
The following is an example of the Remote Traffic Report in table format:

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Remote Traffic Report

5-40

Data fields in this report provide the following information:

USAGE TO

Total connect time initiated from the local system to the remote
system in CCS (hundred call seconds—total seconds divided
by 100).

USAGE FROM

Total connect time initiated from the remote system to the local
system in CCS (hundred call seconds—total seconds divided
by 100).

MSGS SENT

Total number of messages sent from the local system to the
remote system.

MSGS RECEIVED

Total number of messages received by the local system from
the remote system.

To display the Remote Traffic Report:
1. At the AUDIX Traffic Reports menu, select 7) Remote Traffic per Day for a
Period.
The following screen appears:

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Daily System Attendant Traffic Report

5-41

Defaults are as follows:
■

Report Starting Date is the latest Monday for which five days of
traffic data exists on the PC, and the Report Ending Date is the
latest date for which daily system traffic data exists on the PC. You
can change these dates to any dates in a 40-day period for which
daily system traffic data exists on the PC.

■

“Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
blanking out the field, or copy the report to a file by entering a file
name. If you did not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

2. If you wish, change the default output device. Otherwise PC2AUDIX
retrieves the default-specified information.
3. Press

F8

(CHANGE/RUN) to generate the report.

4. If you have Stella Business Graphics installed on your PC, the prompt “Do
you want to see the graphical view of this data?” appears. Enter y to
include graphical output or n to display the report in table format only.
5. The report appears as a table with report fields shown horizontally across
the page and days listed vertically down the page. If you have graphical
output capability and entered y in the previous step, a chart also is
included with the output.

Daily System Attendant Traffic Report
This report displays the call answer traffic for each automated attendant (and its
subattendants) for one day. No data collection is required prior to running this
report; the PC calls the voice mail system to gather appropriate data when this
report is run.
This report lets you see how your attendants are being used. When you first set
up an attendant, you choose the ordering of the options based on which options
you expect to be used most frequently, so that the first choice is expected to be
used more than the second choice and so on in descending order. If menu
options are secondary attendants, this report tells you if you were correct, or if
you need to rearrange the options. If options are not secondary attendants,
similar information can be obtained from call detail recording (CDR) records.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Daily System Attendant Traffic Report

5-42

The following is an example of the Daily System Attendant Traffic Report in table
format:

Data fields in this report provide the following information:

PRIME

Total number of calls placed during prime time hours.

NON-PRIME

Total number of calls placed during non-prime time hours.

TOTAL CALLS

Total number of calls placed during all hours.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Daily System Attendant Traffic Report

5-43

To display the Daily System Attendant Traffic Report:
1. At the AUDIX Traffic Reports menu, select 8) System Attendant Traffic for a
Day.
The following screen appears:

Defaults are as follows:
■

Report Date is seven days prior to the current day. You can change
this date to any date for which traffic data still exists in the voice
mail database.

■

“Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
blanking out the field, or copy the report to a file by entering a file
name. If you did not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

2. Enter the extension of the automated attendant to report on.
3. If you wish, change any or all of the default report data. Otherwise
PC2AUDIX retrieves the default-specified information.
4. Press

F8

(CHANGE/RUN) to begin execution.

5. If you have Stella Business Graphics installed on your PC, the prompt “Do
you want to see the graphical view of this data?” appears. Enter y to
include graphical output or n to display the report in table format only.
6. The report appears as a table with report fields shown horizontally across
the page and attendants listed vertically down the page. If you have
graphical output capability and entered y in the previous step, a chart also
is included with the output. If a system attendant uses an extension which
is recognized as a valid extension on the switch but is not an AUDIX
subscriber, the message not an AUDIX subscriber prints in place of
the traffic statistics for that extension.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Monthly System Attendant Traffic Report

5-44

Monthly System Attendant Traffic
Report
This report displays the call answer traffic for each automated attendant (and its
subattendants) for a month. No data collection is required prior to running this
report; the PC calls the voice mail system to gather appropriate data when this
report is run. This report includes the same types of information as the Daily
System Attendant Traffic Report except information is shown for an entire month
instead of for a specific day.
The following is an example of the Monthly System Attendant Traffic Report in
table format:

Data fields in this report provide the following information :

PRIME

Total number of calls placed during prime time hours.

NON-PRIME

Total number of calls placed during non-prime time hours.

TOTAL CALLS

Total number of calls placed during all hours.

AUDIX Administration and Data Acquisition Package 585-302-502

5

Issue 14
May 1999

PC2AUDIX Traffic Reports
Monthly System Attendant Traffic Report

5-45

To display the Monthly System Attendant Traffic Report:
1. At the AUDIX Traffic Reports menu, select 9) System Attendant Traffic for a
Month.
The following screen appears:

Defaults are as follows:
■

Report Date is the current month. You can change this date to any
month for which traffic data still exists in the voice mail database.

■

“Send output to device” is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
blanking out the field, or copy the report to a file by entering a file
name. If you did not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

2. Enter the extension of the automated attendant to report on
3. If you wish, change any or all of the default report data. Otherwise
PC2AUDIX retrieves the default-specified information.
4. Press

F8

(CHANGE/RUN) to generate the report.

5. If you have Stella Business Graphics installed on your PC, the prompt “Do
you want to see the graphical view of this data?” appears. Enter y to
include graphical output or n to display the report in table format only.
6. The report appears as a table with report fields shown horizontally across
the page and attendants listed vertically down the page. If you have
graphical output capability and entered y in the previous step, a chart also
is included with the output. If the system attendant uses an extension
which is recognized as a valid extension on the switch but is not a voice
mail subscriber, the message not an AUDIX subscriber is printed in
place of the traffic statistics for that extension.

AUDIX Administration and Data Acquisition Package 585-302-502

5

PC2AUDIX Traffic Reports
Monthly System Attendant Traffic Report

Issue 14
May 1999
5-46

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Overview

PC2AUDIX Billing Reports

6-1

6

Overview
This chapter describes the following:
■

How to use PC2AUDIX to produce standardized billing reports for the
voice mail system using downloaded subscriber traffic data

■

How to use the billing package to see how your subscribers are using the
voice mail system

The PC2AUDIX subscriber billing feature generates billing reports for
subscribers and organizations based on actual monthly usage of the voice mail
system.
The billing process consists of the following steps:
1. Define the billing price breakdown — You can specify the cost of the voice
mail system services such as session length, number of accesses,
filesystem space used, and individual feature usage.
2. Calculate the monthly billing — This option calculates the monthly billing
for any selected month which has data available on the PC.
3. Generate the billing reports — A menu displays report format selections
for billing and bill summaries.
Each of these steps is described in this chapter.
You may also use the PC2AUDIX billing feature to find out how subscribers use
the voice mail system. For example, to encourage sending voice mail (and thus
increasing productivity), you could use the billing package to generate a report
showing who sent the most voice mail messages and who sent the fewest (or
none). Another example is to use the billing package to find out who gets the
most call answer calls. This information can help you determine who in your
organization might need further training on using the voice mail system to
become more productive.

AUDIX Administration and Data Acquisition Package 585-302-502

6

PC2AUDIX Billing Reports
Organization Codes

Issue 14
May 1999
6-2

Organization Codes
A key element of the subscriber billing feature is the organization code, which
allows you to define a reporting order for groups and departments in your
organization. The organization code is assumed to be hierarchical (for example,
code 9901 reports to code 990, which reports to code 99). PC2AUDIX assumes
that the relationship between organizations can be determined by scanning
organization codes left to right.
If you ask for a report for organization 99, then all subscribers that have
organization codes starting with 99 are included. If you request a summary report
showing the cost breakdown within an organization, then all organization codes
directly reporting to the specified organization code are included. For example:
an organizational breakdown for organization code 99 might include organization
codes 991, 992, and 993. Organization codes can be any combination of letters
or numbers.

Prerequisites
To generate billing reports, PC2AUDIX requires monthly subscriber traffic data
for the month you are generating the report. This process is described in
Chapter 4, "PC2AUDIX Data Retrieval", or Chapter 8, "Scheduling PC2AUDIX
Data Retrieval".
If you use organization codes, you must assign these codes to individual
subscribers using either the PC2AUDIX site-specific Org. Code data field
described in Chapter 8, "Scheduling PC2AUDIX Data Retrieval", or the misc field
in subscriber records on the voice mail system. If you use the misc field for this
purpose, you must assign it as such in PC2AUDIX Setup Parameters.

Starting the Billing Process
Perform the following steps to initiate the PC2AUDIX subscriber billing feature.
Note that you must retrieve appropriate data from the voice mail database before
reports can be produced.
1. At the DOS prompt C>, enter cd machine_name to change to the directory
for the voice mail system for which you wish to produce billing reports.
2. Enter pc2audix to call PC2AUDIX software.

AUDIX Administration and Data Acquisition Package 585-302-502

6

PC2AUDIX Billing Reports
Define Price Breakdown

Issue 14
May 1999
6-3

3. At the PC2AUDIX Root Menu, select 3) Customer Billing.
The following screen appears:

4. Select the option for the billing function you wish to perform. These options
are individually described on the next several pages.

Define Price Breakdown
This option specifies how the billing calculations are made. The screen displays
current defaults; a zero in any category indicates that item is not considered for
billing purposes.
You can modify any field. Modifications are not permanent until after you press
the F8 (CHANGE/RUN) key. All input fields are numeric. In order to see the
changes made by altering this form, you must recalculate monthly bills by using
the Do Monthly Bill Calculation option.

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Define Price Breakdown

Perform the following steps to define billing price breakdowns:
1. At the Customer Billing menu, select 2) Define Price Breakdown.
The following screen appears:

2. Press F6 (NEXT PG) to display page 2 of the Billing Price Breakdown
screen.
The following screen appears:

6-4

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Define Price Breakdown

6-5

3. Press F6 (NEXT PG) to display page 3 of the Billing Price Breakdown
screen. The following screen appears:

4. Press F6 (NEXT PG) again to redisplay page 1 of the Billing Price
Breakdown screen.
5. Enter values as appropriate on page 1, page 2, or page 3 of this screen.
6. Press

F8

(CHANGE/RUN) to define the billing price breakdown.

You are now ready to calculate the monthly billing as described later in
this chapter.
Billing Price Breakdown Data Fields
Data fields on the three pages of the Billing Price Breakdown screen determine
what types of voice mail system usage to bill for and the respective billing rates.
A zero in any field indicates that field is not included in billing criteria.
Data fields are as follows:
■

The Flat fee field establishes a flat monthly usage fee for all subscribers on
the voice mail system regardless of system usage.

■

The remaining fields are all directly from the DEFINITY AUDIX List
Measurements Subscriber Month screen or the R1 AUDIX traffic :
subscriber : month screen. Use these fields to establish billing values for
the voice mail system subscribers based on actual system usage.
Refer to the DEFINITY AUDIX List Measurements Subscriber Month
screen in the DEFINITY AUDIX System — Forms Reference, 585-300-207,
or the AUDIX Traffic : Subscriber : Month screen in the AUDIX Release 1
Version 8 Forms Reference, 585-306-204, for information about the types
of data collected for each of these fields. Then assign billing rates for
system usage as appropriate for your organization.

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Define Price Breakdown

6-6

Examples
The following examples illustrate how you can set billing price breakdown data
fields to provide specific types of information.
Example #1: Charge for 800-number access.
1. If there are remote subscribers who use an 800 number either to receive
messages or to pick up messages, you can access the charges for that
cost by entering a value in the Session usage fields under PRIME SHIFT
USAGE and NON-PRIME SHIFT USAGE.
2. If the 800 number costs 11 cents a minute (.183 per second), enter .183
under both the USER ACCESS and CALL ANSWER columns.
3. Run the monthly bill calculation.
4. Either separately print out those subscribers who use the 800 number, or
use an organization code to get bills for all subscribers who use the 800
number.
Example #2: Reward for voice mail usage.
1. To get a list (ordered from most to least) of who uses voice mail and who
does not, fill in the Messages created, total messages fields under PRIME
SHIFT USAGE and NON-PRIME SHIFT USAGE. You can use any value,
such as 1.0.
2. Run the monthly bill calculation.
3. Use the List Subscribers With Bills Over Specified Amount option
(described in Chapter 7, "PC2AUDIX Database Searches") to list voice
mail users in descending order based on volume.
Example #3: Find your heaviest users.
1. Enter a value in the Session usage fields under the USER ACCESS column
for both PRIME SHIFT USAGE and NON-PRIME SHIFT USAGE, such as
0001.
2. Run the monthly bill calculation.
3. Use the List Subscribers With Bills Over Specified Amount option
(described in Chapter 7, "PC2AUDIX Database Searches") to find the
heaviest users.

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Monthly Bill Calculation

6-7

Monthly Bill Calculation
This option performs monthly bill calculations using values that were previously
defined on the Billing Price Breakdown form. Bill calculation is done for each
subscriber based on monthly subscriber traffic data collected from the voice mail
system.
NOTE:
Monthly bill calculation can take from one to five seconds per subscriber,
depending on how many non-zero entries you have in the Bill Price
Breakdown form. In other words, at worst case this procedure can take five
seconds for each of 4000 subscribers, which is 5-1/2 hours.
You may remove billing data the Delete Data From Fixed Disk menu option
described in Chapter 10, "PC2AUDIX Database Management Tools".
Perform the following steps to calculate monthly billing:
1. At the Customer Billing menu, select 3) Do Monthly Bill Calculation.
The following screen appears:

The oldest and most current dates of monthly subscriber traffic data on
the PC display. Additionally, dates for billing data left over from previous
billing calculations display.
You must specify the month for which you wish to calculate bills. The
default provided by this screen is the most current date of monthly
subscriber traffic data on this PC.

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-8

2. Choose from the following:
■

Press F8 (CHANGE/RUN) to calculate monthly bills for the
displayed default billing period.

■

Enter a different month to calculate bills for (from within the
displayed range of current monthly subscriber traffic data), and
press F8 (CHANGE/RUN).

Billing calculations are made for the specified month and the number of
subscribers processed appears on the STATUS line. You are now ready to
generate billing reports as described next in this chapter.

Generate Billing Reports
This option generates monthly billing reports. Note that you must complete
Monthly Billing Calculation for the selected month before you can generate
reports.
Perform the following steps to produce monthly billing reports:
1. At the Customer Billing menu, select 1) Generate Reports.
The following screen appears:

2. Select the appropriate option for the billing report you wish to generate.
These options are individually described on the next several pages.

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-9

Generate Organizational Summary Report
This option generates a series of summary reports for the organizational level
specified and each level below it down to the second level. If you do not use
organization codes, these reports provide no useful information. If you have the
graphics package installed, the you can display the output in the form of a pie
chart. (You can change the type of chart from the default if you let the output go
to the PC screen.)
Each summary shows the billing breakdown for the levels just below the level
being reported. You can specify that reports be generated for all organizations
reporting to the level selected.
NOTE:
The first time you generate an organizational report for new billing data, a
you must create a temporary database showing the interrelation between
all organization codes. This can take 10 minutes or longer.
The following is an example of the Organizational Summary Report in table
format:

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-10

Perform the following steps to generate the Organizational Summary Reports:
1. At the Customer Billing Reports menu, select 1) Organizational Summary
Reports.
The following screen appears:

Defaults on this screen are as follows:
■

The organization field defaults to ALL, which generates reports for
all organizations on the voice mail system.

■

The number of levels to include defaults to 1.

■

The Date for Report field is set to the last month for which data has
been collected.

■

Graphical output in the form of a pie chart defaults to N (no).

■

The default output device is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
making the field blank, or copy the report to a file by entering a file
name. If you do not define a printer in PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen. You can copy the report to a file by entering a file
name.

2. Choose from the following:
■

Press F8 (CHANGE/RUN) to generate the reports using the default
specifications.

■

Change any or all of the default specifications, and press
(CHANGE/RUN) to generate the reports as specified.

F8

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-11

The following messages (status and error) may appear when the
organization code relations database is being built:
■

Organizational relations between subscribers needs construction.

Continue (Y) or cancel this operation (N):
■

Do you want to see the graphical view of this data (Y/N)?

Enter Y (yes) or N (no) for these questions as appropriate.
If the data does not exist, an error message appears; select Do Monthly Bill
Calculation under Customer Billing to create billing data needed to generate this
report.

Generate Individual Bill Totals for an
Organization
This option prints out individual billing totals for each member in the specified
organization formatted as one-line totals grouped by first-level organizational
codes. Organization numbers are assumed to be hierarchical (for example, code
9901 reports to code 990, which reports to code 99). If you specify an
organization code above the first level, this generates reports for each first-level
organization code related to the specified code. Bill totals are sorted
alphabetically by last name for all employees with the same organization code.
The following is an example of the Individual Bill Totals for an Organization
Report:

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-12

Perform the following steps to generate Individual Bill Totals for an Organization:
1. At the Customer Billing Reports menu, select 2) Individual Bill Totals for an
Organization.
The following screen appears:

Defaults on this screen are as follows:
■

The organization field defaults to ALL, which generates reports for
all organizations on the voice mail system.

■

The Date for Report field is set to the last month for which data has
been collected.

■

The default output device is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
making the field blank, or to copy the report to a file by entering a
file name. If you do not define a printer in the PC2AUDIX Setup
Parameters, this field is blank by default and the report appears on
the PC screen.

2. Choose from the following:
■

Press F8 (CHANGE/RUN) to generate the report using the default
specifications.

■

Change any or all of the default specifications, and press
(CHANGE/RUN) to generate the report as specified.

F8

The report is generated and sent to the specified output device.
If the data does not exist, an error message appears; select Do Monthly
Bill Calculation under Customer Billing to create billing data needed to
generate this report.

AUDIX Administration and Data Acquisition Package 585-302-502

6

PC2AUDIX Billing Reports
Generate Billing Reports

Issue 14
May 1999
6-13

Generate Detailed Individual Report by
Organization
This option prints the entire bill calculation for each individual member of the
specified organization. Reports are sorted by last name within organization
codes. Organization numbers are assumed to be hierarchical (for example, code
9901 reports to code 990, which reports to code 99). If you specify an
organization code above the first-level, this generates reports for all first-level
organization codes related to the specified code.
The following is an example of the Detailed Individual Report by Organization:

Perform the following steps to generate Detailed Individual Billing Reports by
Organization:
1. At the Customer Billing Reports menu, select 3) Detailed Individual Report
by Organization.

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-14

The following screen appears:

Defaults on this screen are as follows:
■

The organization field defaults to ALL, which generates reports for
all organizations on the voice mail system.

■

List subscribers per page is set to N (no), which prints reports in
sequence without regard to paging; change this to Y (yes) to print
one report per page.

■

The Date for Report field is set to the last month for which data has
been collected.

■

The default output device is the printer defined in the PC2AUDIX
Setup Parameters. You can display the report on the PC screen by
making the field blank, or to copy the report to a file by entering a
file name. If you do not define a printer in PC2AUDIX Setup
Parameter, this field is blank by default and the report appears on
the PC screen. You can copy the report to a file by entering a file
name.

2. Choose from the following:
■

Press F8 (CHANGE/RUN) to generate the reports using the default
specifications.

■

Change any or all of the default specifications, and press
(CHANGE/RUN) to generate the reports as specified.

F8

The reports are generated and sent to the specified output device.
If the data does not exist, an error message appears; select Do Monthly
Bill Calculation under Customer Billing to create billing data needed to
generate these reports.

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-15

Generate Detailed Individual Report by
Subscriber Name
This option is used to inspect the itemized billing record for one subscriber.
Perform the following steps to display Detailed Individual Billing Reports by
Subscriber Name:
1. At the Customer Billing Reports menu, select 4) Detailed Individual
Report by Subscriber Name.
The following screen appears:

2. The BILLmmyy.DBF files are the billing files available for display. Enter the
month to display billing data for. If the month is not specified (press
RETURN ), data for the most recent billing cycle appears. (Disregard the
BILLSPEC.DBF file name. )

AUDIX Administration and Data Acquisition Package 585-302-502

6

Issue 14
May 1999

PC2AUDIX Billing Reports
Generate Billing Reports

6-16

The following screen appears:

3. Enter the name or extension of the subscriber you want to display, and
press F8 (CHANGE/RUN)
The billing record for the specified subscriber appears.
4. You then can select any of the previous options or choose from the
following additional options:
■

Press F3 (NEXT PAGE) to display additional pages (if any) for the
displayed subscriber.

■

Press F4 (NEXT MATCH) to display the next sequential record in the
file with the same name.

■

Press

■

Press F6 (PREV REC) to display the previous sequential record in
the file. If the NAME field is highlighted, the previous name
appears; if the EXT field is highlighted, the previous extension
appears.

F5

(PRINT) to print the subscriber record on your printer.

AUDIX Administration and Data Acquisition Package 585-302-502

7

Issue 14
May 1999

PC2AUDIX Database Searches
Overview

PC2AUDIX Database Searches

7-1

7

Overview
PC2AUDIX data search tools perform the following tasks:
■

List all subscribers with bills over a specified amount.

■

List all subscribers with usage over or under a specified limit.

■

List all subscribers with mailbox space thresholds over specified limits.

Each of these capabilities is described in this chapter.
NOTE:
If you want to check current space thresholds and the data is not current on
the PC, collect Monthly Subscriber Traffic Data or Daily Subscriber Traffic
Data under Data Retrieval to obtain current user space information.
Similarly, you can only check for users with high bills after the bills have
been calculated using Monthly Billing Calculation under Customer Billing.

AUDIX Administration and Data Acquisition Package 585-302-502

7

PC2AUDIX Database Searches
Initiating PC2AUDIX Database Searches

Issue 14
May 1999
7-2

Initiating PC2AUDIX Database
Searches
Perform the following steps to initiate PC2AUDIX data searches:
1. Bring up the PC2AUDIX software.
2. At the PC2AUDIX Root Menu, select 6) Searches.
The following screen appears:

3. Select the appropriate option for the PC2AUDIX data search you wish to
perform. These options are individually described on the next several
pages.

AUDIX Administration and Data Acquisition Package 585-302-502

7

PC2AUDIX Database Searches
List Subscribers with Bills Over Specified Amount

Issue 14
May 1999
7-3

List Subscribers with Bills Over
Specified Amount
This option searches the billing records for the last billing cycle (generated by
the Monthly Billing Calculation under Customer Billing) and lists subscribers with
bills greater than the specified amount.
You can also use this option (combined with the billing package) to find your
heaviest users, to find out who uses the voice mail feature, and for other search
purposes. The following is an example of the PC2AUDIX output for subscribers
with bills over a specified amount.

Perform the following steps to list subscribers with bills over a specified amount:
1. At the SEARCHES menu, select 1) List subscribers with bills over
specified amount.

AUDIX Administration and Data Acquisition Package 585-302-502

7

Issue 14
May 1999

PC2AUDIX Database Searches
List Subscribers with Bills Over Specified Amount

7-4

The following screen appears:

The month specification is set to the last billing cycle calculated.
The “Bills Greater than” field defaults to $25.00, which you can modify to
suit your requirements.
The default output device is the printer defined in the PC2AUDIX Setup
Parameters. You can display the report on the PC screen by making the
field blank, or to copy the report to a file by entering a file name. If you do
not define a printer in PC2AUDIX Setup Parameters, this field is blank by
default and the report appears on the PC screen.
2. Choose from the following:
■

Press F8 (CHANGE/RUN) to find subscribers over the default billing
amount for the displayed month.

■

Change any or all of the displayed defaults, and press F8
(CHANGE/RUN) to find subscribers whose billing is over the
specified amount for the specified period.

PC2AUDIX generates a list of all subscribers with bills over the specified
total. The list is sorted by bill total and includes each subscriber’s name,
extension, organization code, and the bill total. The report sequence is
from most to least.

AUDIX Administration and Data Acquisition Package 585-302-502

7

Issue 14
May 1999

PC2AUDIX Database Searches
List Subscribers with Usage Over/ Under Specified Limits

7-5

List Subscribers with Usage Over/
Under Specified Limits
This option searches the most recent subscriber traffic data to locate subscribers
who use the voice mail system more or less than the specified amount. The
default specifications are set to search for subscribers with less than five
accesses during the last month for which you have traffic data on this PC. This
allows you to identify those subscribers who are not active users of the voice mail
system. By changing LESS to MORE, you can reverse the sense of the search
and locate users who use the voice mail system heavily. Note that this data is
only as current as the last traffic data retrieved from the voice mail system.
The following is an example of PC2AUDIX output for subscribers who use the
voice mail system more or less than the specified amount:

Perform the following steps to list subscribers with usage over or under a
specified amount:
1. At the SEARCHES menu, select 2) List subscribers with usage over/under
specified limits.

AUDIX Administration and Data Acquisition Package 585-302-502

7

Issue 14
May 1999

PC2AUDIX Database Searches
List Subscribers with Usage Over/ Under Specified Limits

7-6

The following screen appears:

The month specification is set to the last traffic data collected. If you
change this date and traffic information does not exist for that month, the
date field changes to the month for which traffic information does exist
closest to the date you chose.
The default output device is the printer defined in the PC2AUDIX Setup
Parameters. You can display the report on the PC screen by making the
field blank, or to copy the report to a file by entering a file name. If you do
not define a printer in PC2AUDIX Setup Parameters, this field is blank by
default and the report appears on the PC screen.
2. Choose from the following:
■

Press F8 (CHANGE/RUN) to find subscribers with usage less than
the default number of accesses during the displayed period.

■

Change any or all of the displayed defaults, and press F8
(CHANGE/RUN) to find subscribers with usage greater than or less
than the specified number of accesses for the specified period.

If you pressed F8 (CHANGE/RUN) in the previous step, a list of all
subscribers with accesses over or under the specified amount is
generated. The list is sorted by the number of accesses and then
alphabetically by subscriber.

AUDIX Administration and Data Acquisition Package 585-302-502

7

Issue 14
May 1999

PC2AUDIX Database Searches
List Subscriber Space Threshold Exceptions

7-7

List Subscriber Space Threshold
Exceptions
This option searches the most recent subscriber traffic data to locate subscribers
with mailboxes that exceed the specified space threshold. Note that this data is
only as current as the last traffic data retrieved from the voice mail system.
The following is an example of the PC2AUDIX interface output for subscriber
space thresholds:

Perform the following steps to list subscribers who exceed specified space
thresholds:
1. At the SEARCHES menu, select 3) List subscriber space threshold
exceptions.

AUDIX Administration and Data Acquisition Package 585-302-502

7

Issue 14
May 1999

PC2AUDIX Database Searches
List Subscriber Space Threshold Exceptions

7-8

The following screen appears:

The month specification is set to the month in which traffic data last was
collected. If you change this date and traffic information does not exist for
that month, the Month field changes to the month for which traffic
information does exist closest to the date you chose. If you desire daily
traffic data, fill in the Optional day field with the desired day (1-31).
The maximum and current space used default is 80 percent. To search for
subscribers on just the current mailbox space used or just the maximum
mailbox space used, blank out the other field by placing 100 on the
unwanted field. PC2AUDIX then searches for only the desired condition,
as the other condition lists subscribers with CUR or MAX percent greater
than 100 percent which cannot be true. You cannot blank out these fields;
since they are numeric, dBASE does not permit spaces.
The default output device is the printer defined in the PC2AUDIX Setup
Parameters. You can display the report on the PC screen by making the
field blank, or copy the report to a file by entering a file name. If you do not
define a printer in PC2AUDIX Setup Parameters, this field is blank by
default and the report appears on the PC screen.
2. Choose from the following:
■

Press F8 (CHANGE/RUN) to find subscribers whose current or
maximum mailbox space exceeds the default space thresholds
during the displayed period.

■

Change any or all of the displayed defaults, and press F8
(CHANGE/RUN) to find subscribers whose current or maximum
mailbox space exceeds the specified space thresholds during the
specified period.

PC2AUDIX generates a list of subscribers whose maximum or current
mailbox size exceeds the specified thresholds. Subscribers are sorted in
descending order by maximum percentage.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Scheduling PC2AUDIX Data Retrieval
Overview

Scheduling PC2AUDIX Data
Retrieval

Issue 14
May 1999
8-1

8

Overview
With the PC2AUDIX scheduling option, you can establish a schedule for regularly
retrieving appropriate system and subscriber traffic data, error and alarm log
data, performance statistics, and reported maintenance events (DEFINITY
AUDIX system only). You also can schedule subscriber database verification.
Additionally, if the optional Call Detail Recording (CDR) package is installed, you
can schedule CDR data retrieval for the AUDIX system. (The Call Detail
Recording package is not available with the DEFINITY AUDIX system.)
You can schedule up to 100 events to occur on an hourly, daily, bi-weekly, weekly,
bi-monthly, or monthly basis. Additionally, for AUDIX networks, a single
PC2AUDIX schedule can accommodate data verification and retrieval from all
local and remote AUDIX systems in the network.
You initiate and control scheduling from the PC2AUDIX Root Menu using the
Schedule Editor (5). This option displays a scheduling menu, which in turn
provides options for entering, displaying, and editing events; providing retrieval
instructions for specific events; and displaying the event log of past scheduled
activities.
Once you have scheduled events, you must place the PC in scheduling mode
(option 0 on the PC2AUDIX Root Menu) during the time that events are
scheduled to occur. At the scheduled time, the PC calls the voice mail system to
initiate the scheduled activity.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Scheduling Events

8-2

Scheduling Events
Perform the following steps to schedule events:
1. At the PC2AUDIX Root Menu, select 5) Schedule Editor to display the
AUDIX Scheduling Menu.
The following screen appears:

2. Choose one of the following:
■

Select 1) Display/Edit Schedule by day/time

■

Select 2) Display/Edit Schedule by machine/day/time

These options display the same information, except the first option
displays entries sorted by day and time while the second option displays
entries sorted by system and then by day and time.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Scheduling PC2AUDIX Data Retrieval
Scheduling Events

Issue 14
May 1999
8-3

The following screen appears:

3. Press F4 (ADD ENTRY) to add a new entry to the PC2AUDIX schedule of
events.
The following screen appears:

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Scheduling Events

8-4

4. Enter the following information on the Add Schedule Entry screen:
■

Machine
The name of the work directory you created for a particular voice
mail system. The Machine name may be a maximum of 10
characters.

■

Day
The day for which to schedule the event. Valid entries are as
follows:
— A three-character abbreviation for the day of the week (sun,
mon, tue, wed, thu, fri, sat, or all).
— A one- or two-digit number (1 to 31) representing the day of
the month to schedule the event.
— hr.
This option is only valid for activity types on the R1 AUDIX
system (see Table 8-1, Valid Activity Types). When you enter
hr in the Day field, PC2AUDIX retrieves performance
statistics every day on an hourly basis from the beginning of
the scheduled event until the designated stop collection
hour.
Alternatively, if you enter a day or number in the Day field for
performance statistics, PC2AUDIX collects data just once
each time the event is scheduled. (In this case, the
designated stop collection hour defines the interval if
statistics cannot be collected at the scheduled time, and any
value in the Interval field is ignored.)

■

Time
The time of day the transmission is scheduled to begin, specified
as hh:mm, where hh is the hour (00 to 23) and mm is the minute (00
to 59).

■

Interval
The amount of time after the scheduled starting time in which the
transmission must begin, specified as hh:mm, where hh is the hour
(00 to 23) and mm is the minute (00 to 59).
If the transmission has not begun within this interval, the event is
skipped. For example, if an event is scheduled to begin at 02:00
and the interval is 05:00, the event is skipped if it has not started by
07:00. If an interval of 00:00 is specified, only the standard number
of retries (three) to establish a connection are made.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Scheduling Events
■

8-5

Activity
The activity that is to be performed at the scheduled time. Valid
activities are as follows:
— verify
Schedule subscriber database verification.
— traffic
Schedule retrieval of voice mail traffic data.
— logs
Schedule retrieval of voice mail error, alarm, and/or events
logs. You may retrieve the events log only for the DEFINITY
AUDIX system.
— perform
Schedule retrieval of voice mail performance statistics.
— cdr
Schedule retrieval of CDR records for the R1 AUDIX system.

■

Type
Further defines the activity to be performed at the scheduled time.
No type is specified for the cdr activity. The following table shows
the valid activity types:

Table 8-1.

Valid Activity Types

Activity

Type

Description

verify

local

Verify PC2AUDIX local subscriber
database against the voice mail
database.

remote

Verify PC2AUDIX remote subscriber
database against the voice mail
database.

subscriber-d

Retrieve daily subscriber traffic data.

subscriber-m

Retrieve monthly subscriber traffic
data.

system-d

Retrieve daily system traffic data.

system-h

Retrieve hourly system traffic data.

system-m

Retrieve monthly system traffic data.

traffic

Continued on next page

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Scheduling Events

Table 8-1.

8-6

Valid Activity Types — Continued

Activity

Type

Description

logs

active_alarm

Retrieve maintenance active alarm
log. Output file is getaalar.out

error

Retrieve maintenance error log.
Output file is geterror.out

res_alarm

Retrieve maintenance resolved alarm
log. Output file is getralar.out

events

Retrieve DEFINITY AUDIX
maintenance events log. Output file is
getevent.out

fp/vsp

Retrieve feature processor and voice
session processor performance
statistics (R1 AUDIX system only).
Output file is perfout.[100-999]

dbp

Retrieve database processor
performance statistics (R1 AUDIX
system only). Output file is
perfout.[100-999].

all

Retrieve fp/vsp and dbp performance
statistics on R1 AUDIX system.
Required for DEFINITY AUDIX
system. Output file is
perfout.[100-999].

perform

cdr

Refer to Call Detail Recording
Package (585-305-506) for
information about scheduling CDR
data collection (R1 AUDIX system
only).

Continued on next page
5. When you have entered all Add Schedule Entry information this event,
press F8 (CHANGE/RUN) to schedule the event.
PC2AUDIX verifies that the fields entered are acceptable. If any entered
data is invalid, PC2AUDIX displays an error message.
6. If you scheduled a traffic activity in the previous steps, you must next
specify the start and stop collection dates and times for the scheduled
activity.
The appropriate data collection screen appears automatically for each
scheduled traffic activity. The displayed data specification screen is
similar to the Hourly System Traffic Data Collection screen.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Scheduling Events

8-7

7. Depending on which data collection screen appears, you are prompted
for the following information:
■

Hourly System Traffic Data Collection screen — Prompts for start
collection month/day/year/hour and stop collection
month/day/year/hour up to 192 hours total. Also used for DEFINITY
AUDIX system performance data.

■

Daily System Traffic Data Collection screen — Prompts for start
collection month/day/year and stop collection month/day/year up to
31 days total.

■

Monthly System Traffic Data Collection screen — Prompts for start
collection month/year and stop collection month/year up to 13
months total.

■

Daily Subscriber Traffic Data Collection screen — Prompts for
collection month/day/year.

■

Monthly Subscriber Traffic Data Collection screen — Prompts for
collection month/year.

■

AUDIX system Performance Data Collection screen — Prompts for
stop collection hour. If you specified hr in the Day field on the Add
Schedule Entry screen for this event, statistics are not gathered
past the hour specified here. If you specified a day or number on
that screen instead of hr, retry attempts do not continue past the
hour specified here.

8. After entering the appropriate data collection specification data, press
F8 (CHANGE/RUN) to schedule the event.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Scheduling PC2AUDIX Data Retrieval
Scheduling Call Detail Recording (CDR) Data Retrieval

Issue 14
May 1999
8-8

9. After scheduling the event, press F7 to return to the Display/Edit Schedule
screen to schedule another even. (or press F9 to return to the PC2AUDIX
Root Menu).
10. When you have scheduled all events, select 0) Run Scheduled Event) on
the PC2AUDIX Root Menu. The Schedule Mode screen appears.

The current time and next scheduled event appear on the Schedule Mode
screen. You must display this screen at the time of the next scheduled
event or the event is skipped.
You can exit from the Schedule Mode screen to the PC2AUDIX Root Menu
at any time when a scheduled event is not in progress. However, you must
re-invoke scheduling mode by again selecting option 0 (Run Scheduled
Events) on the PC2AUDIX Root Menu before the time of the next
scheduled event or the event is skipped. There is one exception to this; if
you re-invoke scheduling mode after the next scheduled event, the next
scheduled event still runs if the interval is set long enough to cover the
amount of time that the event is late.

Scheduling Call Detail Recording
(CDR) Data Retrieval
Retrieving Call Detail Recording (CDR) data is similar to the previous scheduling
tasks, but you must first establish CDR collection parameters through the
PC2AUDIX Setup Parameters screens. Refer to AUDIX Call Detail Recording
Package, 585-305-506, for information about scheduling the retrieval of CDR
data using the PC2AUDIX interface. CDR data retrieval is not available with the
DEFINITY AUDIX system.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Displaying and Editing Scheduled Events

8-9

Displaying and Editing Scheduled
Events
Perform the following steps to display and edit scheduled events:
1. At the PC2AUDIX Root Menu, select 5) Schedule Editor to display the
Scheduling Menu.
The following screen appears:

2. Choose one of the following:
■

Select 1) Display/Edit Schedule by day/time

■

Select 2) Display/Edit Schedule by machine/day/time

These options display the same information, except the first option
displays entries sorted by day and time while the second option displays
entries sorted by system and then by day and time.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Scheduling PC2AUDIX Data Retrieval
Displaying and Editing Scheduled Events

Issue 14
May 1999
8-10

The following screen displays all scheduled events:

3. Press F2 (PREV PG), F3 (NXT PG), F5 (PREV ENTRY), and F6 (NEXT
ENTRY) as required to scroll through the scheduled events and highlight
the entry you want to edit.
4. Press

F8

(EDIT ENTRY) to edit the highlighted entry.

The following screen appears with data from the highlighted scheduled
event already filled in:

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Displaying the Scheduled Event Log

8-11

5. Choose from the following:
■

To delete the displayed scheduled event, press

■

To edit the displayed scheduled event, change data in the fields as
appropriate; and press F8 (CHANGE/RUN).

F6

(DELETE).

If the scheduled event is for a traffic, verify, logs, or perform activity,
the event’s Data Collection screen appears next. Change data in
the fields of this screen if appropriate, and press F8
(CHANGE/RUN) again.
■

To edit just the event’s Data Collection screen, press F8
(CHANGE/RUN) at the Edit Schedule Entry screen without making
any changes to that screen. The event’s Data Collection screen
appears next. Change data in the fields of this screen as
appropriate, and press F8 (CHANGE/RUN) again.

When you have completed all event editing, you must re-invoke scheduling
mode by again selecting 0) Exit ADAP to Scheduled Events on the PC2AUDIX
Root Menu before the time of the next scheduled event or the event is skipped.
There is one exception to this; if you re-invoke scheduling mode after the next
scheduled event, the next scheduled event still runs if the interval is set long
enough to cover the amount of time that the event is late.
For each voice mail system whose name has been placed in the Machine field on
the Schedule Entry screen, you must properly complete the information on the
Setup Parameters screen in the working directory for that system. This enables
PC2AUDIX to know how to communicate with the system when the scheduler
determines it is time to perform the requested task.

Displaying the Scheduled Event Log
The PC2AUDIX interface maintains an event log that records the status of
PC2AUDIX events as they occur. This log contains information about each
scheduled event, including the following:
■

If the event did occur as scheduled and the number of records created
(for CDR retrievals only).

■

If the event did not occur as scheduled, the reason for failure.

■

If the event was interrupted, the reason for the interruption, the number of
records created (for CDR retrievals only).

The last page of the event log appears with the most recently retrieved event as
the last entry on the page.

AUDIX Administration and Data Acquisition Package 585-302-502

8

Issue 14
May 1999

Scheduling PC2AUDIX Data Retrieval
Displaying the Scheduled Event Log

Perform the following steps to display the scheduled event log:
1. At the PC2AUDIX Root Menu, select 5) Schedule Editor to display the
Scheduling Menu.
2. At the AUDIX Scheduling Menu, select 3) Display Event Log for
Scheduler.
A screen similar to the following appears:

3. The event log is a chronological listing of scheduled activity; the most
recent event appears at the bottom of the list.

8-12

AUDIX Administration and Data Acquisition Package 585-302-502

9

Issue 14
May 1999

PC2AUDIX Site Specific Data
Overview

PC2AUDIX Site Specific Data

9-1

9

Overview
PC2AUDIX site specific data tools provide you with the following capabilities:
■

You can change subscriber names and extensions in the PC2AUDIX
database. PC2AUDIX automatically updates these changes in the voice
mail database.

■

You can enter data specific to PC2AUDIX in individual local subscriber
records in the PC2AUDIX subscriber database. These changes are not
updated in the voice mail database.

■

You can display individual local subscriber records, showing the
subscriber’s name, extension, new name and new extension, class of
service, miscellaneous and comment fields, organization code, title, and
location.

■

You can list all local subscribers who have a specified organization code,
class of service, and miscellaneous field.

■

You can display individual remote subscriber records, showing the
subscriber’s name, extension, machine, type (administered,
non-administered verified, non-administered unverified, or
non-administered no-profile), and last usage date.

■

You can list all remote subscribers who have a specified type or machine.

Each of these capabilities is described in this chapter.

AUDIX Administration and Data Acquisition Package 585-302-502

9

Issue 14
May 1999

PC2AUDIX Site Specific Data
Selecting Site Specific Data Options

9-2

Selecting Site Specific Data Options
Perform the following steps to display and manipulate PC2AUDIX site-specific
data.
1. Call the PC2AUDIX interface software.
2. At the PC2AUDIX Root Menu, select 4) Site Specific Data.
The following screen appears:

3. Select the appropriate option for the site-specific operation you wish to
perform. These options are individually described on the next several
pages.

Display/Update Information for Local
Subscribers
This option displays individual local subscriber records and sets subscriber data
fields that are exclusive to the PC2AUDIX database (not found in the voice mail
system subscriber database), including the subscriber’s title, location,
organization code, and an optional comment field. You also can change the
subscriber’s name and extension which affects both the subscriber database on
the PC and the voice mail database.
Perform the following steps to display/update information for local subscribers:
1. At the Non-AUDIX Data Field Specification menu, select 2) Display/update
information for local subscribers.

AUDIX Administration and Data Acquisition Package 585-302-502

9

PC2AUDIX Site Specific Data
Display/Update Information for Local Subscribers

Issue 14
May 1999
9-3

The following screen appears with data for the first local subscriber in the
database:

2. Enter the name or extension of a subscriber in the Name or Extension field
respectively and press F8 (CHANGE/RUN) to display that person’s
subscriber record.
A subscriber record appears.
The Name, Extension, and COS fields are exactly as supplied by the voice
mail system when the subscriber information was retrieved and verified.
You can modify the New Name, New Extension, Org. Code, Title, Location,
and Comment Field fields. PC2AUDIX validates data in only the New
Name and New Extension fields.
If you change the name or extension in the New Name or New Extension
fields, you cannot have duplicate subscriber names, and the extension
must be within the range specified by the local voice system.
If you wish to modify the COS or Misc. Field fields, make the required
modifications in the voice mail database and then verify the subscriber
database as described in Chapter 4, "PC2AUDIX Data Retrieval", to merge
these changes into the PC2AUDIX database.
The Org. Code field, which is used by the PC2AUDIX subscriber billing
feature, can be any combination of letters or numbers. The organization
code also can be the Miscellaneous field on the Subscriber screen on the
voice mail system, if specified as such in PC2AUDIX Setup Parameters.
Organization codes are assumed to be hierarchical (9901 reports directly
to organization 990, which reports to organization 99, etc.) The PC2AUDIX
interface assumes that the relationship between organizations can be
determined by scanning organization codes left to right.

AUDIX Administration and Data Acquisition Package 585-302-502

9

Issue 14
May 1999

PC2AUDIX Site Specific Data
List All Fields for All Local Subscribers

9-4

You can use the Title, Location, and Comment Field fields for whatever
purposes you find suitable for your organization.
3. You can now press F8 (CHANGE/RUN) again to display the next
subscriber record in sequence, press F6 (PREV REC) to display the
previous subscriber record in sequence, enter a specific different name or
extension to display, or modify data on the displayed record.
4. If you change any data fields for a subscriber, press
before continuing.

F8

(CHANGE/RUN)

! CAUTION:
If you re-verify the subscriber database, you lose any data that exists
only in the PC database and not in the voice mail database.

List All Fields for All Local
Subscribers
This option allows you to generate an alphabetical listing of local subscribers
using PC2AUDIX site-specific data fields for search specification.
The following is an example of the PC2AUDIX interface output for this listing:

Perform the following steps to list all fields for all local subscribers:
1. At the Non-AUDIX Data Field Specification menu, select 1) List all fields for
all local subscribers.

AUDIX Administration and Data Acquisition Package 585-302-502

9

Issue 14
May 1999

PC2AUDIX Site Specific Data
List All Fields for All Local Subscribers

9-5

The following screen appears:

The default output device is the printer defined in the PC2AUDIX Setup
Parameters. You can display the report on the PC screen by making the
field blank, or copy the report to a file by entering a file name. If you do not
define a printer in PC2AUDIX Setup Parameters, this field is blank by
default and the report appears on the PC screen.
2. Choose from the following:
■

Change the Include comment field in output? to Y and the output
device if desired, and press F8 (CHANGE/RUN) to list all local
subscribers.

■

Change the following as appropriate:
— Organization #, AUDIX COS Field, and AUDIX Subscriber
Misc. Field parameters
— Include comment field in output? to Y
— The output device
Then press F8 (CHANGE/RUN) to list subscribers who meet the
specified search criteria.

All subscribers are listed who match the specified conditions.

AUDIX Administration and Data Acquisition Package 585-302-502

9

Issue 14
May 1999

PC2AUDIX Site Specific Data
Display Information for Remote Subscribers

9-6

Display Information for Remote
Subscribers
This option displays individual remote subscriber records, including the
subscriber’s name, extension, new name and new extension if changed,
machine, type (administered, non-administered verified, non-administered
unverified, or non-administered no-profile), and last usage date.
Perform the following steps to display information for remote subscribers:
1. At the Non-AUDIX Data Field Specification menu, select 4) Display
information for remote subscribers.
The following screen displays data for the first remote subscriber in the
database:

2. Enter the name or extension of a remote subscriber in the Name or
Extension field respectively.
3. Press

F8

(CHANGE/RUN) to display that person’s subscriber record.

A remote subscriber record appears. You then can press F8
(CHANGE/RUN) again to display the next subscriber record in sequence,
press F6 (PREV REC) to display the previous subscriber record in
sequence, or enter a specific different name or extension to display.
All fields on the screen are exactly as supplied by the voice mail system
when the subscriber information was retrieved and verified. If you wish to
modify any of these fields, make the required modifications in the voice
mail database and then verify the remote subscriber database as
described in Chapter 4, "PC2AUDIX Data Retrieval". This changes the
PC2AUDIX database to match the voice mail database.

AUDIX Administration and Data Acquisition Package 585-302-502

9

Issue 14
May 1999

PC2AUDIX Site Specific Data
List All Fields for All Remote Subscribers

9-7

List All Fields for All Remote
Subscribers
This option generates an alphabetical listing of remote subscribers using
PC2AUDIX data fields for search specification.
The following is an example of the PC2AUDIX interface output for this listing.

Perform the following steps to list all fields for all remote subscribers:
1. At the Non-AUDIX Data Field Specification menu, select 3) List all fields
for all remote subscribers.

AUDIX Administration and Data Acquisition Package 585-302-502

9

Issue 14
May 1999

PC2AUDIX Site Specific Data
List All Fields for All Remote Subscribers

9-8

The following screen appears:

The default output device is the printer defined in the PC2AUDIX Setup
Parameters. You can display the report on the PC screen by making the
field blank, or copy the report to a file by entering a file name. If you do not
define a printer in PC2AUDIX Setup Parameters, this field is blank by
default and the report appears on the PC screen.
2. Choose from the following:
■

Change the output device if desired and press
to list all remote subscribers.

■

Change the Subscriber Type and Machine fields as appropriate
and the output device if desired, and then press F8
(CHANGE/RUN) to list remote subscribers who meet the specified
search criteria.

F8

(CHANGE/RUN)

All remote subscribers who match the specified conditions are listed.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Overview

10-1

PC2AUDIX Database Management
Tools

10

Overview
PC2AUDIX data management tools help you to: back up data (retrieved from the
voice mail system) from your PC to diskette; restore files from diskette; and delete
files from your PC. Managing your data is important for several reasons:
■

Periodically backing up data files protects you if your fixed disk drive
becomes damaged. Backed up files can then be restored from diskette to
your PC.

■

Periodically deleting data from your PC frees up space for new data. As
system traffic data files (hourly, daily, and monthly) become larger, it takes
longer for PC2AUDIX to find the records needed to generate reports.
Deleting old data makes file access quicker for PC2AUDIX. You may wish
to archive data before deleting it.

■

Archiving retrieved data onto diskette allows you to later restore it to make
historical comparisons of data several months or even years in the future.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
File Naming Conventions

10-2

File Naming Conventions
Data files created by PC2AUDIX are named according to the type of data they
contain:

load_hr.dbf
load_day.dbf

hourly system load traffic data
daily system load traffic data

feat_hr.dbf
feat_day.dbf

hourly system feature traffic data
daily system feature traffic data

tr_nethr.dbf
tr_netda.dbf

hourly system network load traffic data
daily system network load traffic data

spfeathr.dbf
spfeatda.dbf

hourly system special features traffic data
daily system special features traffic data

comm_hr.dbf
comm_day.dbf

hourly system community traffic data
daily system community traffic data

tr_remda.dbf
tr_remmo.dbf

daily system remote messages traffic data
monthly system remote messages traffic data

smmmyy.dbf

monthly subscriber traffic data for the specified month
and year

sd mmddyy.dbf

daily subscriber data for the specified date

billmmyy.dbf

monthly billing data for the specified month

subdata.dbf

PC2AUDIX subscriber directory database records

rsubdata.dbf

PC2AUDIX remote subscriber directory database records

Initiating Data Management Functions
The data management portion of PC2AUDIX has two menu levels. The top menu,
the Data Management Options menu, gives you access to the Data Backup,
Data Deletion, and Restore Data submenus. These three submenus allow you to
backup, delete, or restore several types of PC2AUDIX data files.
Perform the following steps to initiate file backup, deletion, or restoration:
1. Call the PC2AUDIX software by entering pc2audix at the DOS prompt.
2. At the PC2AUDIX Root Menu, select 7) Data Management.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-3

The following menu appears.

3. Enter 1, 2, or 3 to select the desired option. Each data management option
is described in a corresponding section in this chapter.

Backing Up Retrieved Data
The Data Backup subhuman provides backup for seven types of data. This
option copies retrieved voice mail data from your PC to diskette. Backing up data
files is very important so that you can restore these files if your fixed disk
becomes damaged.
To back up data, perform the following:
1. At the Data Management Options menu, select 1) Backup Data to
Diskette.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-4

The following screen appears. Notice that the screen provides data
ranges indicating the oldest and most recent data.

2. Select the type of data that you wish to back up. This brings up a
corresponding backup screen, which is described in detail in this section.
NOTE:
If you have a lot of hourly traffic records, you may need several
diskettes. Be sure to label the backup diskette(s) with the dates of
the oldest and most recent traffic data. The AUDIX Data Backup
menu displays this information.

Back Up Hourly System Traffic Data
This option backs up retrieved hourly traffic data, including feature, load, network
load, community, and special features records for all dates.
Perform the following steps to back up hourly system traffic data:
1. At the AUDIX Data Backup menu, select 1) Hourly System Traffic Data.
The Hourly System Traffic Data Backup screen appears (This backup
screen consists only of four function key labels.)
2. Press

F8

(CHANGE/RUN) to start the backup.

PC2AUDIX displays the backup filename, database size, instructions to
insert a diskette, and a prompt for formatting the diskette.
3. Enter y if you want to format the diskette, otherwise enter n.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-5

4. Press any key to continue, at the prompt. PC2AUDIX copies the displayed
file to the diskette.
When the file has been backed up, the previous message reappears with
information about the next hourly traffic file to back up and prompts you to
press any key to continue.
5. If the diskette fills up, insert another diskette at the prompt.
When all data files are backed up, a message appears on the Status line
indicating that the backup completed successfully.
After you have made a backup copy, you can use the Delete Data From Fixed
Disk option to delete old (unneeded) records.

Back Up Daily System Traffic Data
This option backs up retrieved daily traffic data, including daily traffic feature,
traffic load, traffic network load, traffic community, traffic remote messages, and
traffic special features records for all dates.
Perform the following steps to back up daily system traffic data:
1. At the AUDIX Data Backup menu, select 2) Daily System Traffic Data.
The Daily System Traffic Data Backup screen appears. (This backup
screen consists of four function key labels.)
2. Press

F8

(CHANGE/RUN) to start the backup.

PC2AUDIX displays the backup filename, database size, instructions to
insert a diskette, and a prompt for formatting the diskette.
3. Enter y to format the diskette, otherwise enter n.
4. Press any key to continue, at the prompt. PC2AUDIX copies the displayed
file to the diskette.
When the file has been backed up, the previous message reappears with
information about the next daily traffic file to back up and the prompt to
press any key to continue.
5. If the diskette fills up, insert another diskette at the prompt.
When all daily system traffic files are backed up, a message appears on
the Status line indicating that the backup completed successfully.
After you have made a backup copy, you can use the Delete Data From Fixed
Disk option to delete old (unneeded) records.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-6

Back Up Monthly System Traffic Data
This option backs up retrieved monthly traffic data, including monthly traffic
remote messages records.
Perform the following steps to back up monthly system traffic data:
1. At the AUDIX Data Backup menu, select 3) Monthly System Traffic Data.
The Monthly System Traffic Data Backup screen appears. (This backup
screen consists only of the four function key labels.)
2. Press

F8

(CHANGE/RUN) to start the backup.

PC2AUDIX displays the backup filename, database size, instructions to
insert a diskette, and a prompt for formatting the diskette.
3. Enter y to format the diskette, otherwise enter n.
4. Press any key to continue, at the prompt. PC2AUDIX copies the displayed
file to the diskette.
5. If the diskette fills up, insert another diskette at the prompt.
When all monthly system traffic files are backed up, a message appears
on the Status line indicating that the backup completed successfully.
After you have made a backup copy, you can use the Delete Data From Fixed
Disk option to delete old (unneeded) records.

Back Up Monthly Subscriber Traffic Data
This option backs up retrieved monthly subscriber traffic data. This monthly
subscriber traffic data is used by PC2AUDIX to calculate monthly bills. It is wise
to keep backup copies of this data.
Backup copies are made for one month’s worth of data at a time. If you have a
more than 4,000 subscribers, you may need more than one 360 KB diskette for
each month of data.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-7

Perform the following steps to back up monthly subscriber traffic data:
1. At the AUDIX Data Backup menu, select 4) Monthly Subscriber Traffic
Data.
The following screen appears:

The default month in the Date of Data field is the month of the oldest
monthly subscriber traffic data that was found.
2. Enter a different month for which to back up monthly subscriber data, or
use the default months.
3. Press

F8

(CHANGE/RUN).

PC2AUDIX displays the backup filename, database size, instructions to
insert a diskette, and a prompt for formatting the diskette.
4. Enter y to format the diskette, otherwise enter n.
5. Press any key to continue, at the prompt. PC2AUDIX copies the displayed
file to the diskette.
6. If the diskette fills up, insert another diskette at the prompt.
When the specified data has been backed up, a message appears on the
Status line indicating that the backup completed successfully.
7. Enter a different month for which to back up monthly subscriber traffic
data, and press F8 (CHANGE/RUN) to back up data for that month.
After you have made a backup copy, you can use the Delete Data From Fixed
Disk option to delete old (unneeded) records.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-8

Back Up Daily Subscriber Traffic Data
This option backs up retrieved daily subscriber traffic data. Backup copies are
made for one day’s worth of data at a time. If you have more than 4000
subscribers, you may need more than one 360 KB diskette for each day of data.
Perform the following steps to back up daily subscriber traffic data:
1. At the AUDIX Data Backup menu, select 5) Daily Subscriber Traffic Data.
The following screen appears:

The Date of Data field defaults to the date of the oldest daily subscriber
traffic data.
2. Enter a different date for which to back up daily subscriber data, or use
the default subscriber date.
3. Press

F8

(CHANGE/RUN).

PC2AUIDX displays the backup filename, database size, instructions to
insert a diskette, and a prompt for formatting the diskette.
4. Enter y if you want to format the diskette, otherwise enter n.
5. Press any key to continue, at the prompt. PC2AUDIX copies the displayed
file to the diskette.
6. If the diskette fills up, insert another diskette at the prompt.
When the specified data has been backed up, a message appears on the
Status line indicating that the backup completed successfully.
7. Enter a different date for which to back up daily subscriber traffic data,
and press F8 (CHANGE/RUN) to back up data for that date.
After you have made a backup copy, you can use the Delete Data From Fixed
Disk option to delete old (unneeded) records.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-9

Back Up Monthly Billing Data
This option backs up retrieved monthly billing data. It is wise to keep backup
copies of billing data in case duplicate records are required in the future.
Billing data is created from Monthly Traffic Subscriber data using the Monthly Bill
Calculation form. This file varies in size depending on how many billing
conditions you selected on the Define Price Breakdown form and on how many
subscribers are in your database.
Perform the following steps to back up monthly billing data:
1. At the AUDIX Data Backup menu, select 6) Monthly Billing Data.
The following screen appears:

The Date of Data field defaults to the month of the oldest monthly billing
calculation data.
2. Enter a different month(s) to back up other monthly billing data, or use the
default billing months.
3. Press

F8

(CHANGE/RUN).

PC2AUDIX displays the backup filename, database size, instructions to
insert a diskette, and a prompt for formatting the diskette.
4. Enter y to format the diskette, otherwise enter n.
5. Press any key to continue at the prompt. PC2AUDIX copies the displayed
file to the diskette.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Backing Up Retrieved Data

10-10

6. If the diskette fills up, insert another diskette at the prompt.
When all monthly billing data has been backed up for the specified month,
a message appears on the STATUS line indicating that the backup
completed successfully.
7. Enter a different month to back up monthly billing data and press
(CHANGE/RUN) to back up data for that month.

F8

After you have made a backup copy, you can use the Delete Data From Fixed
Disk option to delete old (unneeded) records.

Back Up Subscriber Site Data
This option backs up PC2AUDIX subscriber information. This includes
information contained in PC2AUDIX subscriber records but not in subscriber
records in the voice mail database, such as room number, job title, and
organization code. It is wise to keep backup copies of this data, especially since
this data may not be available from another source.
If you have more than 4000 subscribers, you may need more than one 360 KB
diskette. You should keep a current backup, plus one additional backup copy
(the previous backup). Beyond two backup copies you can recycle the diskettes.
Perform the following steps to back up subscriber site data:
1. At the AUDIX Data Backup menu, select 7) Subscriber Site Data.
The Subscriber Site Data Backup screen appears. (This screen consists
of four function key labels.)
2. Press

F8

(CHANGE/RUN) to start the backup procedure.

PC2AUDIX displays the backup filename, database size, instructions to
insert a diskette, and a prompt for formatting the diskette.
3. Enter y if you want to format the diskette, otherwise enter n.
4. Press any key to continue, at the prompt. PC2AUDIX copies the displayed
file to the diskette.
5. If the diskette fills up, insert another diskette at the prompt.
When all data has been backed up, a message appears on the Status line
indicating that the backup completed successfully.
After you have made a backup copy, you can use the Delete Data From Fixed
Disk option to delete old (unneeded) records.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Deleting Retrieved Data

10-11

Deleting Retrieved Data
The Data Deletion submenu provides deletion of six types of data files. This
option deletes old or unneeded data (files and/or records) from your PC. Make
sure you have a valid backup copy before deleting essential data. The voice mail
system keeps a fixed amount of information about system and subscriber traffic.
If you delete information from the PC, it may not be available from the voice mail
machine if you wish to view that information again.
NOTE:
Use extreme caution with this option as you may not be able to reverse its
effects if the information no longer exists on the voice mail system. You may
want to have a backup copy of the data on diskette.
Perform the following steps to delete retrieved data from your PC:
1. At the Data Management Options menu, select 2) Delete Data From Fixed
Disk.
The following submenu appears:

2. Select the option corresponding to the type of data you want to delete.
This section instructs you how to delete each data type.
NOTE:
If you are out of space on your PC fixed disk, deletion of subscriber
data (options 4 or 5) reclaims the most space.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Deleting Retrieved Data

10-12

Delete Hourly System Traffic Data
Perform the following steps to delete hourly system traffic data:
1. At the AUDIX Data Deletion menu, select 1) Hourly System Traffic Data.
The following screen appears:

The Oldest Data and Latest Data show what data is present on the PC.
The start and stop deletion dates and times default to the date and time of
the oldest hourly system traffic data record. You can change the start
deletion date and time and leave a gap in the records, but this is not
recommended.
2. If you wish, change the stop deletion date and hour, otherwise use the
default dates.
3. Press

F8

(CHANGE/RUN).

PC2AUDIX prompts you, Do you want traffic files from
 to  deleted?
4. Enter y to delete the specified data, otherwise enter n. If you enter n, you
can enter different start and stop dates and times, or use a function key to
exit without deleting data.
When the requested data has been deleted, a message appears on the
Status line showing how many records were deleted.
5. To delete additional records, repeat step 2 through step 4.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Deleting Retrieved Data

10-13

Delete Daily System Traffic Data
Perform the following steps to delete daily system traffic data:
1. At the AUDIX Data Deletion menu, select 2) Daily System Traffic Data.
The following screen appears:

The Oldest Data and Latest Data show what data is present on your PC.
The start and stop deletion dates default to the date of the oldest daily
system traffic data record. You can modify the start deletion date and
leave a gap in the records, but this is not recommended.
2. If you wish, change the stop deletion date, otherwise use the default date.
3. Press

F8

(CHANGE/RUN).

PC2AUDIX prompts you, Do you want traffic files from
 to  deleted?
4. Enter y to delete the specified data, otherwise enter n. If you enter n, you
can enter different start and stop dates and times, or use a function key to
exit without deleting data.
When the requested data has been deleted, a message is displayed on
the Status line showing how many records were deleted.
5. To delete additional records, repeat step 2 through step 4.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Deleting Retrieved Data

10-14

Delete Monthly System Traffic Data
Perform the following steps to delete monthly system traffic data:
1. At the AUDIX Data Deletion menu, select 3) Monthly System Traffic Data.
The following screen appears:

The Oldest Data and Latest Data show what data is present on your PC.
The start and stop deletion months default to the month of the oldest
monthly system traffic data record. You can change the start deletion
month and leave a gap in the records, but this is not recommended.
2. If you wish, change the stop deletion month, otherwise use the default
month.
3. Press

F8

(CHANGE/RUN).

PC2AUDIX prompts you, Do you want traffic files from
 to  deleted?
4. Enter y to delete the specified data, otherwise enter n. If you enter n, you
can enter different start and stop months, or use a function key to exit
without deleting data.
When the requested data has been deleted, a message appears on the
Status line showing how many records were deleted.
5. If you wish to delete additional data, repeat step 2 through step 4.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Deleting Retrieved Data

10-15

Delete Monthly Subscriber Traffic Data
Perform the following steps to delete monthly subscriber traffic data:
1. At the AUDIX Data Deletion menu, select 4) Monthly Subscriber Traffic
Data.
The following screen appears:

The Oldest Data and Latest Data show what data is present on the PC.
The start and stop deletion months default to the month of the oldest
monthly subscriber traffic data record. You can change the start deletion
month and leave a gap in the records, but this is not recommended.
2. If you wish, change the stop deletion month, otherwise use the default
month.
3. Press

F8

(CHANGE/RUN) to delete the records you have specified.

PC2AUDIX prompts you, Do you want traffic files from
 to  deleted?
4. Enter y to delete the specified data, otherwise enter n. If you enter n, you
can enter different start and stop months, or use a function key to exit
without deleting data.
When the requested data has been deleted, a message appears on the
Status line showing how many files were deleted.
5. If you wish to delete additional records, repeat step 2 through step 4.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Deleting Retrieved Data

10-16

Delete Daily Subscriber Traffic Data
Perform the following steps to delete daily subscriber traffic data:
1. At the AUDIX Data Deletion menu, select 5) Daily Subscriber Traffic Data.
The following screen appears:

The Oldest Data and Latest Data show what data is present on the PC.
The start and stop deletion dates default to the date of the oldest daily
subscriber traffic data record. You can change the start deletion date and
leave a gap in the PC data records, but this is not recommended.
2. If you wish, change the stop deletion date, otherwise use the default
dates.
3. Press

F8

(CHANGE/RUN).

PC2AUDIX prompts you, Do you want traffic files from
 to  deleted?
4. Enter y to delete the specified data, otherwise enter n. If you enter n, you
can enter different start and stop dates and times, or use a function key to
exit without deleting data.
When the requested data has been deleted, a message appears on the
Status line showing how many files were deleted.
5. If you wish to delete additional records, repeat step 2 through step 4.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Deleting Retrieved Data

10-17

Delete Monthly Billing Data
Perform the following steps to delete monthly billing information:
1. At the AUDIX Data Deletion menu, select 6) Monthly Billing Data.
The following screen appears:

The Oldest Data and Latest Data show what data is present on the PC.
The start and stop deletion months default to the month of the oldest
monthly billing calculation data record. You can change the start deletion
month and leave a gap in the records, but this is not recommended.
2. If you wish, change the stop deletion month, otherwise use the default
month.
3. Press

F8

(CHANGE/RUN).

PC2AUDIX prompts you, Do you want billing data files from
 to  deleted?
4. Enter y to delete the specified data, otherwise enter n. If you enter n, you
can enter different start and stop dates and times, or use a function key to
exit without deleting data.
When the requested data has been deleted, a message appears on the
Status line showing how many files were deleted.
5. If you wish to delete additional records, repeat step 2 through step 4.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-18

Restoring Retrieved Data
The Restore Data from Diskette submenu lets you restore seven types of data
files. This option restores data from previous backups by copying backed up
data from diskettes to your PC. Use this procedure if you have a fixed disk failure,
or if you wish to inspect data that has been previously backed up and then
deleted from your PC.
NOTE:
If you a large file has been stored on multiple disks, PC2AUDIX prompts
you to insert the next diskette.

! CAUTION:
These restore procedures OVERWRITE current data on the fixed disk. If you
are performing a restore operation to inspect old data, back up the current
data first. Then, when you are through inspecting the old data you restored,
restore the current data you backed up.
Perform the following steps to restore data from diskette(s) to your PC:
1. At the Data Management Options menu, select 3) Restore Data from
Diskette.
The following submenu appears.

2. Select the option corresponding to the type of data you wish to restore.
This section describes how to restore each data type.
NOTE:
If a single file is restored backed up to multiple diskettes, be sure to
restore diskettes in the proper order (disk 1 first, then disk 2).

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-19

Restore Hourly System Traffic Data
This option restores hourly system traffic data, including feature traffic, load
traffic, network load traffic, community traffic, and special features traffic.
Perform the following steps to restore hourly system traffic data:
1. At the Restore Data from Diskette menu, select 1) Hourly Data.
The Restore Hourly System Traffic Data screen appears. (All restore
screens consist of function key labels.)
2. Press

F8

(CHANGE/RUN) to start the restore.

The following messages appear:
Restore Databases Matching  from Diskette 1.
Is Backup Disk in drive A? (Y/N) _

 indicates that this restore will overwrite the indicated file.
3. Enter y if the correct diskette is inserted in your floppy drive, otherwise
enter n. (If you enter n, the restore screen reappears with function key
options to proceed or exit as before.)
For each hourly system traffic file, PC2AUDIX displays this prompts:
Do you want to restore .DBF (Y/N)?
5. Enter y to restore the file, otherwise enter n to skip restoring it.
When you have restored (or not restored) the displayed file, PC2AUDIX
prompts you to restore the next hourly system traffic file in sequence.
6. Repeat steps 4 and 5 to restore other hourly system traffic files.
When all hourly system traffic files have been restored (or not restored),
PC2AUDIX displays the number of files restored.
7. Press F8 (CHANGE/RUN) to continue restoring hourly system traffic data
files. Do this if you inadvertently chose not to restore a file in the previous
steps or if you encountered a problem with the diskette and you need to
retry the operation.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-20

Restore Daily System Traffic Data
Perform the following steps to restore daily system traffic data:
1. At the Restore Data from Diskette menu, select 2) Daily Data.
The Restore Daily System Traffic Data screen appears.
2. Press

F8

(CHANGE/RUN) to start the restore.

The following messages appear:
Restore Databases Matching  from Diskette 1.
Is Backup Disk in drive A? (Y/N) _

 indicates that this restore overwrites the indicated file.
3. Enter y if the correct diskette is inserted in the floppy drive, otherwise
enter n. (If you enter n, the restore screen reappears with function key
options to proceed or exit as before.)
For each daily system traffic file, PC2AUDIX displays this prompts:
Do you want to restore .DBF (Y/N)?
5. Enter y to restore the file, otherwise enter n to skip restoring it.
When you have restored (or not restored) the displayed file, PC2AUDIX
prompts you to restore the next daily system traffic file in sequence.
6. Repeat steps 4 and 5 to restore other daily system traffic files.
When all daily system traffic files have been restored (or not restored),
PC2AUDIX displays the number of files restored.
7. Press F8 (CHANGE/RUN) to continue restoring daily system traffic files.
Do this if you inadvertently chose not to restore a file in the previous steps
or if a problem was encountered with the diskette and you need to retry
the operation.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-21

Restore Monthly System Traffic Data
Perform the following steps to restore monthly system traffic data:
1. At the Restore Data from Diskette menu, select 3) Monthly Data.
The Restore Monthly System Traffic Data screen appears.
2. Press

F8

(CHANGE/RUN) to start the restore.

The following messages appear:
Restore Databases Matching  from Diskette 1.
Is Backup Disk in drive A? (Y/N) _

 indicates that the restore overwrites the indicated file.
3. Enter y if the correct diskette is inserted in the floppy drive, otherwise
enter n. (If you enter n, the restore screen reappears with function key
options to proceed or exit as before.)
PC2AUDIX displays the prompt:
Do you want to restore TR_REMMO.DBF (Y/N)?
4. Enter y to continue restoring, otherwise enter n.
PC2AUDIX displays the prompt:
OVERWRITE C:.DBF (Y/N)?
5. Enter y to restore the file, otherwise enter n to skip restoring it.
When you have restored (or not restored) the displayed file, PC2AUDIX
prompts you to restore the next monthly system traffic file in sequence.
6. Repeat steps 4 and 5 to restore other monthly system traffic files.
When all monthly system traffic files have been restored (or not restored),
PC2AUDIX displays the number of files restored.
7. Press F8 (CHANGE/RUN) to continue restoring monthly system traffic files.
Do this if you inadvertently chose not to restore the file in the previous
steps or if a problem was encountered with the diskette and you need to
retry the operation.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-22

Restore Monthly Subscriber Traffic Data
Perform the following steps to restore monthly subscriber traffic data:
1. At the Restore Data from Diskette menu, select 4) Subscriber Monthly
Data.
The Restore Subscriber Monthly Traffic Data screen appears.
2. Press

F8

(CHANGE/RUN) to start the restore.

The following messages appear:
Restore Databases Matching  from Diskette 1.
Is Backup Disk in drive A? (Y/N) _

 indicates that this restore overwrites the indicated file.
3. Enter y if the correct diskette is inserted in the floppy drive, otherwise
enter n. (If you enter n, the restore screen reappears with function key
options to proceed or exit as before.)
PC2AUDIX prompts you:
Do you want to restore SMmmyy.DBF (Y/N)?
The filename reflects the oldest month of subscriber traffic data found on
the diskette.
4. Enter y to continue restoring, otherwise enter n.
PC2AUDIX displays the prompt:
OVERWRITE C: (Y/N)?
5. Enter y to restore the file, otherwise enter n to skip restoring it.
When you have restored (or not restored) the displayed file, PC2AUDIX
prompts you to restore the next monthly subscriber traffic file in sequence.
6. Repeat steps 4 and 5 to restore other monthly subscriber traffic files.
When all monthly subscriber traffic files have been restored (or not
restored), PC2AUDIX displays the number of files restored.
7. Press F8 (CHANGE/RUN) to continue restoring monthly subscriber traffic
files. Do this if you inadvertently chose not to restore a file in the previous
steps or if a problem was encountered with the diskette and you need to
retry the operation.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-23

Restore Daily Subscriber Traffic Data
Perform the following steps to restore daily subscriber traffic data:
1. At the Restore Data from Diskette menu, select 5) Subscriber Daily Data.
The Restore Subscriber Daily Traffic Data screen appears.
2. Press

F8

(CHANGE/RUN) to start the restore.

The following messages appear:
Restore Databases Matching  from Diskette 1.
Is Backup Disk in drive A? (Y/N) _

 indicates that this restore overwrites the indicated file.
3. Enter y if the correct diskette is inserted in the floppy drive, otherwise
enter n. (If you enter n, the Restore Daily Subscriber Traffic Data screen
reappears with function key options to proceed or exit as before.)
PC2AUDIX prompts you:
Do you want to restore SDmmddyy.DBF (Y/N)?
4. Enter y to continue restoring, otherwise enter n.
PC2AUDIX displays the prompt:
OVERWRITE C:SDmmddyy.DBF (Y/N)?
5. Enter y to restore the file, otherwise enter n to skip restoring it.
When you have restored (or not restored) the displayed file, PC2AUDIX
prompts you to restore the next daily subscriber traffic file in sequence.
6. Repeat steps 4 and 5 to restore other subscriber traffic files.
When all daily subscriber traffic files have been restored (or not restored),
PC2AUDIX displays the number of files restored.
7. Press F8 (CHANGE/RUN) to continue restoring daily subscriber traffic
data files. Do this if you inadvertently chose to not restore a file in the
previous steps or if a problem was encountered with the diskette and you
need to retry the operation.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-24

Restore Monthly Billing Data
Perform the following steps to restore monthly billing data:
1. At the Restore Data from Diskette menu, select 6) Billing Data.
The Restore Billing Data screen appears.
2. Press

F8

(CHANGE/RUN) to start the restore.

The following messages appear:
Restore Databases Matching  from Diskette 1.
Is Backup Disk in drive A? (Y/N) _

 indicates that this restore overwrites the indicated file.
3. Enter y if the correct diskette is inserted in the floppy drive, otherwise
enter n. (If you enter n, the restore screen reappears with function key
options to proceed or exit as before.)
PC2AUDIX prompts you:
Do you want to restore BILLmmyy.DBF (Y/N)?
The filename reflects the oldest month of billing data found on the diskette.
4. Enter y to continue restoring, otherwise enter n.
PC2AUDIX displays the prompt:
OVERWRITE C:BILLmmyy.DBF (Y/N)?
5. Enter y to restore the file, otherwise enter n to skip restoring it.
When you have restored (or not restored) the displayed file, PC2AUDIX
prompts you to restore the next monthly billing file in sequence.
6. Repeat steps 4 and 5 to restore other monthly billing files.
When all monthly billing files have been restored (or not restored),
PC2AUDIX displays the number of files restored.
7. Press F8 (CHANGE/RUN) to continue restoring monthly billing files. Select
this option if you inadvertently chose not to restore a file in the previous
steps or if a problem was encountered with the diskette and you need to
retry the operation.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-25

Restore Subscriber Site Data
Perform the following steps to restore subscriber site data:
1. At the Restore Data from Diskette menu, select 7) Subscriber Site Data.
The Restore Subscriber Site Data screen appears.
2. Press

F8

(CHANGE/RUN) to start the restore.

The following messages appear:
Restore Databases Matching  from Diskette 1.
Is Backup Disk in drive A? (Y/N) _

 indicates that this restore overwrites the indicated file.
3. Enter y if the correct diskette is inserted in the floppy drive, otherwise
enter n. (If you enter n, the restore screen reappears with function key
options to proceed or exit as before.)
PC2AUDIX prompts you:
Do you want to restore SUBDATA.DBF (Y/N)?
4. Enter y to continue restoring, otherwise enter n.
PC2AUDIX displays the prompt:
OVERWRITE C:SUBDATA.DBF (Y/N)?
5. Enter y to restore the file, otherwise enter n to skip restoring it.
When you have restored (or not restored) the displayed file, PC2AUDIX
prompts you to restore the next subscriber site file (RSUBDATA.DBF) .
6. Enter y to restore the file, or enter n to skip restoring it.
When both files have been restored (or not restored), PC2AUDIX displays
the restore screen, as before.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

10 PC2AUDIX Database Management Tools
Restoring Retrieved Data

10-26

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Overview

11-1

Using the ADAP Command Line
Language

11

Overview
This chapter describes how to use the ADAP command line language. It tells
you:
■

How to log into or out of the voice mail system from your PC.

■

How to use ADAP commands to retrieve data directly from the
ADAP-supported voice mail screens.

■

How to use ADAP commands to modify subscriber records in the voice
mail database, activity log parameters in the DEFINITY AUDIX or INTUITY
database, and call detail recording (CDR) screens data and adjunct
machine data in the AUDIX database.

You can use these commands from the MS-DOS prompt C>, from an MS-DOS
batch file, or from within an application program.
This chapter focuses on the basic knowledge you need to use these commands,
including input and output requirements and basic strategies. Individual
commands for retrieving and modifying data in the database are summarized in
this chapter and then described individually in the next two chapters.
These ADAP commands give you a UNIX-like PC interface for:
■

retrieving data to the PC for further processing.

■

modifying subscriber data directly in the voice mail database.

Commands may be upper or lower case; options are case sensitive.
MS-DOS limits program names to eight characters, plus an optional suffix of up
to three characters. All commands described here have a suffix of .exe, which
indicates the files are executable from the DOS prompt.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Logging Into the Voice Mail System

11-2

Logging Into the Voice Mail System
To use ADAP commands, you must first log into the voice mail system from your
PC. You can login from the MS-DOS prompt C>, from an MS-DOS batch file, or
from within an application program. Once you are logged into the voice mail
system, you may execute a series of instructions with intermixed ADAP and
MS-DOS commands.
You can log in to the voice mail system from the PC using:
■

An automatic login procedure (alogin), which combines all of the login
identification information in one step
OR

■

A manual login procedure (login), which requires that you enter individual
responses for the login prompts

These two procedures are described in this section.

Automatic Login Procedure
Use the alogin command to log into the voice mail system automatically without
further interaction. The format for this command is shown below. Optional
arguments are enclosed by square brackets ([ ... ]).
alogin -d device [-b baud rate] [-p communications port]
[-I modem initialization string ] [-i] [-R] [-t] [-r release]
[-v] [-w] [-V] [-P System Password ] loginID password
[ phone number]

alogin

Automatic login.

-d

Device type flag; must be followed by device.

device

Valid device types are: pdm (MPDM data modules), hayes
(Hayes-compatible modems), att4000 (AT&T’s 1200-baud
modem) and direct (direct cable connection).

-b

Baud rate flag; must be followed by baud rate. If no baud
rate is specified, defaults to 4800.

baud rate

Valid transfer baud rates are 1200, 2400, 4800, or 9600. The
AUDIX R1 system supports only 1200 and 4800.

-p

Communications port flag; must be followed by
communications port. If no port is specified, defaults to 1.

communications
port

Valid communications ports are 1 or 2.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Logging Into the Voice Mail System

11-3

-I

Modem initialization string flag; must be followed by modem
initialization string .

modem
initialization string

Specifies an initialization string to be sent to the modem
before connection to the voice mail system is attempted.
The default is a null string.

-i

Causes the system to bypass the search for the data set
ready (DSR) signal. Use this option only with a
Hayes-compatible modem.

-R

If errors occur during the login (such as an invalid login
attempt), causes the connection to be dropped and
automatically retried from the beginning, up to three times.

-t

Causes the system to inhibit the terminal code prompt.
Include this option only when using the 513 BCT emulator
software on the PC. This causes software control to be
returned to operating system at the point the AUDIX system
sends the terminal code or Terminal Type prompt to the
ADAP machine.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the voice mail
system software (D-r3.2, D-r3.1, D-r3.0, D-r2.0, D-r1.0, r1v8,
r1v7, r1v6, r1v5, r1v4_5, r1v4, r1v3, r1v2, I-r5.0, I-r4.0, I-r3.3,
I-r3.2, or I-r2.0). For DEFINITY AUDIX, the default is D-r3.2.
For INTUITY AUDIX, the default is I-r5.0.

-w

Writes a one-line summary of the exit status of this
command into the file alogin.rc.

-v

Writes detailed transfer statistics of the alogin command
status and the voice mail system connect responses to the
screen. This is primarily a debugging aid.

-V

Writes the ADAP version number for this command and exits
without logging in.

-P

System password flag; must be followed by System
Password . This flag is only valid when connecting to an
INTUITY AUDIX or DEFINITY AUDIX system under the cust
login.

System Password

Identifies your DEFINITY AUDIX or Lucent INTUITY system
password. If you have a null system password, use a space
followed by "" .

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Logging Into the Voice Mail System

11-4

loginID

Identifies your voice mail system login ID.

password

Identifies your voice mail system login password.

phone number

Identifies the voice mail system phone number. This number
is not required for direct cable configurations. If you have a
Hayes-compatible or AT&T 4000 modem, enter t in front of
the phone number for touch-tone dialing.

NOTE:
The -P option is required when logging into a DEFINITY AUDIX system as
cust and is invalid otherwise.
While executing this command, the software makes three attempts to connect
with the voice mail system. If the -R (retry) option flag is set and errors occur
during the login (such as an invalid login attempt), the connection is dropped
and automatically retried from the beginning, up to three times.
If you specify an invalid option or omit a required option, the following message
appears:

If this happens, check your options and re-enter the command.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Logging Into the Voice Mail System

11-5

The -I feature is intended to send initialization strings to Hayes and Hayescompatible modems. However, you can use the -I option to send a startup string
to any local connection-establishing device, such as a PDM or modem, that
returns the string "OK" to the computer upon processing and acting on a valid
string.
The alogin command does no checking of the validity of the initialization string
but relies on the connection device returning an "OK" to the COM1 or COM2 port
when the device is successful in using the string. Spaces are legal in Hayes
initialization strings. If strings containing spaces are used with this -I option, you
must enclose the string in double quotes when following the -I on the command
line.
If you attempt to log in without using the -i option when your modem does not
generate a DSR signal, the following message (with the appropriate port number)
appears:
alogin: connect: eopen of port 1 failed, rc = Ox85
processing stopped
If this happens, re-enter the alogin command and include the -i option.
DEFINITY AUDIX Release 3.2 introduces password aging of the AUDIX login
password (password argument of the alogin command). Should this password
expire, choose a new one and login manually. The AUDIX system prompts you
through the password changing procedure.

Manual Login Procedure
Use the login command to log into the voice mail system manually. The format
for this command is shown below. Optional arguments are enclosed by square
brackets ([ ... ]).
login [-b baud rate] [-p communications port] [-i] [-V] [-r release]

login

Specifies a manual login.

-b

Baud rate flag; must be followed by baud rate. If no baud
rate is specified, defaults to 4800.

baud rate

Valid transfer baud rates are 1200, 2400, 4800, or 9600.
The AUDIX R1 system supports only 1200 and 4800. The
DEFINITY AUDIX and Lucent INTUITY systems support 1200,
2400, 4800, and 9600.

-p

Communications port flag; must be followed by
communications port.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Logging Into the Voice Mail System

11-6

communications
port

Specifies that the communications port is either 1 or 2. If no
port is specified, port 1 is the default.

-i

Directs the system to bypass the search for the data set
ready (DSR) signal. Use this option only with
Hayes-compatible modems.

-V

Writes the ADAP version number for this command and
exits without logging in.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the voice mail
system software
(D-r3.2, D-r3.1, D-r3.0, D-r2.0, D-r1.0, r1v8, r1v7, r1v6, r1v5,
r1v4_5, r1v4, r1v3, r1v2, I-r5.0, I-r4.0, I-r3.3, I-r3.2, or
I-r2.0). For DEFINITY AUDIX, the default is D-r3.2. For
INTUITY AUDIX, the default is I-r5.0.

If you enter an invalid argument with the login command, the following message
appears:
C:\PCIFCE\LOGIN.EXE: illegal option -- option
Usage: login [b <1200/2400/4800/9600>] [p <1/2>] [r
release] [iV]
If all arguments are correct, the following messages appear on the screen with
the cursor positioned on the next line (no prompt appears):
 = break;  = quit; Ready to Send
This message is for information only. The F1 key acts as the BREAK key for the
login command — for example, to get the attention of the modular processor
data module (MPDM) if the keyboard break option is enabled on the MPDM,
press F1 .
If you attempt to log in without using the -i option when your modem does not
generate a DSR signal, the following message (with the appropriate port number)
appears:
alogin: connect: eopen of port 0 failed, rc = Ox85
processing stopped
If this happens, re-enter the login command and include the -i option.
If you need to exit the manual login procedure at any time, press

Ctrl-c

.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Logging Into the Voice Mail System

11-7

After you run the login command, perform the following steps:
1. Use one of the following procedures, depending on your PC configuration:
Hayes or AT&T 4000 modem connection:
a. Type atdt
b. Enter the phone number of the voice mail machine administration
port.
MPDM connection:
a. Press

F1

(Break).

b. Enter the phone number of the voice mail machine administration
port.
Direct connection:
a. Go directly to step 2.
2. Press

ENTER

until you see the login prompt appears on the screen.

3. Enter your voice mail login ID. The Password (or password for the AUDIX
system) prompt appears on the screen.
4. Enter your voice mail password .
5. If you are connecting to a DEFINITY AUDIX, a System Password prompt
appears on the screen. Enter your System Password .
6. If you enter an invalid login ID or password(s), the following AUDIX system
message appears:
login id/password invalid
OR
the following DEFINITY or INTUITY AUDIX system message appears:
Login incorrect
ADAP then prompts you for your login ID and password(s). Check your
login ID and/or password(s), and re-enter each in response to the
prompts. If valid login ID and password(s) are entered, the DEFINITY
AUDIX or Lucent INTUITY Terminal Type or R1 AUDIX terminal code prompt
appears on the screen.
7. Enter pc.
The following message appears:
Kermit communications server beginning...
If you are connecting to an R1 AUDIX system, you also see:
#N3

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Logging Out of the Voice Mail System

11-8

8. If this message does not appear, press Ctrl-d to log out of an R1 AUDIX
system; then go back to step 1 and log in again. On a DEFINITY AUDIX or
Lucent INTUITY system, press Ctrl-c to exit the login command. Then
re-enter the login command and go back to step 1 to log in again.
Otherwise, go on to the next step.
9. Press

ESC

.

The MS-DOS prompt appears, indicating that you have successfully
logged into the voice mail system from the PC.
You can now execute the ADAP commands to retrieve screens data or modify
subscriber records.

Logging Out of the Voice Mail System
To log out of the voice mail system enter the logout command. This sends a
Ctrl-d disconnect character to the system and causes the DTR (data terminal
ready) signal to be dropped for half a second, disconnecting the modem.
The logout command also sends the Hayes modem string "+++ATH" in case
your modem is Hayes-compatible. This command takes approximately 5
seconds to complete.

Interrupting a Command
To interrupt a command in progress, press
re-appears.

Ctrl-c

. The MS-DOS prompt

You may receive faster response to your termination requests if you set the DOS
command BREAK to ON. See information in your MS-DOS user’s guide about the
BREAK command usage.

Command Line Commands
The following section describes how to use the command line commands to
retrieve and modify data in the voice mail database. It describes the command
format, how to use the record description tables, the input records, the output
records, and the return codes.
The command line commands and their corresponding screens are listed in the
tables at the end of this chapter.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-9

Command Format
Database retrieval and modification commands are associated with specific
voice mail system administrative and maintenance screens that are supported by
ADAP. Each command option begins with a dash, followed immediately by a
one-letter option identifier. If the option requires an argument, the argument
immediately follows the option letter. You can insert spaces between the option
and the argument for readability — they will be ignored.
Optional arguments are enclosed by square brackets ([ ... ]).
For example, you might enter the gettraf command as follows:
gettraf -f month -d 1294 -i
In the previous gettraf line command,

-f

Option flag for specifying either month or day

month

Argument specifying that the monthly traffic screen data should
be accessed

-d

Option flag for specifying date

1294

Argument identifying the month of traffic to be accessed (Dec.
1994)

-i

Option allowing individual extensions to be entered interactively
from the keyboard

The following options are common to both retrieval and modification commands:

-V

Version flag. When you use this option, the ADAP version
number appears and the command exits.

-w

Exit status flag. This option writes a one-line summary of
the exit status of this command into a file. Screen retrieval
and nonsubscriber database modification commands
write to form_req.rc; subscriber database modification
commands write to main.rc; alogin writes to alogin.rc;
and get_cdr writes to getcdr.rc.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

-r

11-10

Release number flag. Must be followed by the release
number, which identifies the version of the DEFINITY
AUDIX system (D-r3.2, D-r3.1, D-r3.0, D-r2.0, or D-r1.0),
the R1 AUDIX system (r1v8, r1v7, r1v6, r1v5, r1v4_5,
r1v4, r1v3, r1v2), or the INTUITY AUDIX system
(I-r5.0, I-r4.0, I-r3.3, I-r3.2, or I-r2.0) with which it is
communicating. The default for DEFINITY AUDIX is
D-r3.2. The default for INTUITY AUDIX is I-r5.0.

When accessing an R1 AUDIX System or a DEFINITY AUDIX System other
than release 3.2, you may want to change the default release value to
correspond to the release of that AUDIX system. This allows you to enter
retrieval and modify commands for this AUDIX system without using the
-r release option. Prior to executing retrieval and modify commands, set the
AUDIX_RELEASE environment variable to the release value you want by
entering one of the commands listed below:

When accessing a DEFINITY
AUDIX System

When accessing an
R1AUDIX System

set AUDIX_RELEASE=D-r1.0

set AUDIX_RELEASE=r1v2

set AUDIX_RELEASE=D-r2.0

set AUDIX_RELEASE=r1v3

set AUDIX_RELEASE=D-r3.0

set AUDIX_RELEASE=r1v4

set AUDIX_RELEASE=D-r3.1

set AUDIX_RELEASE=r1v4_5
set AUDIX_RELEASE=r1v5
set AUDIX_RELEASE=r1v6
set AUDIX_RELEASE=r1v7
set AUDIX_RELEASE=r1v8

To clear this environment variable, enter the following command:
set AUDIX_RELEASE=
without a release value. This restores D-r3.2 as the default release value.
Similarly, when accessing an INTUITY AUDIX system other than release I-r5.0,
you may want to change the default release value to correspond to the release
of that AUDIX system. This allows you to enter retrieval and modify commands
for this AUDIX system without the need to use the -r release option.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-11

You do this in a manner similar to the above. Prior to executing retrieval and
modify commands, set the AUDIX_RELEASE environment variable to the
release value you want by entering one of the commands listed below:
set AUDIX_RELEASE=I-r2.0
set AUDIX_RELEASE=I-r3.2
set AUDIX_RELEASE=I-r3.3
set AUDIX RELEASE=I-r4.0
To clear this environment variable, enter the following command:
set AUDIX_RELEASE=
without a release value. This restores I-r5.0 as the default release value.
-v

Verbose flag. This option displays information about the
data transfer from the voice mail system to ADAP when
the data transfer is complete.

The following options are available for both retrieval and modification
command s
q

Press during transmission to quit the transfer gracefully.
This may take some time.

v

Press during transmission to view the current
transmission statistics on the screen.

NOTE:
For screens with very little data, and, therefore, a very rapid transfer rate, the
transmission may complete before you are able to press q or v.
When using the -v option or pressing v in communicating the voice mail
system, the following information appears in the following sequence:

DEFINITY and INTUITY AUDIX
Systems

R1 AUDIX Systems

Elapsed time of the full data
transmission

Number of packets sent

Number of files/forms transmitted

Number of packets received

Total characters in the files/forms

Number of packets retransmitted due
to packet/protocol errors

Total number of bytes received

No. of characters of screen data
received

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-12

DEFINITY and INTUITY AUDIX
Systems

R1 AUDIX Systems

Total number of bytes sent

Number of screens received

Number of packets sent

Effective character reception rate in
bits per second (b/s)

Number of packets received

Elapsed time of the full data
transmission

Number of damaged packets
received
Number of time-outs waiting for
packets
Number of packets retransmitted due
to packet/protocol errors
Number of window slots used
Number of compressed characters
Effective character transmission rate
in bits per second (b/s)
Record Description Tables
The ADAP commands accept input and create output in record formats. This
section describes the input and output record formats used by these commands.
The tables in Chapter 12, "Command Line Database Retrieval Commands", and
Chapter 13, "Command Line Database Modification Commands", tell you what
the ADAP program accepts as input and what to expect from the output. The
table below is an example output layout for the getmlist command.

Field

Voice Mail Versions

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

C

10

r1v3+

D-r1.0+

I-r2.0+

voice id

C

3

r1v3+

D-r1.0+

I-r2.0+

3

machine type

C

12

r1v4+

D-r1.0+

I-r2.0+

4

callback number

K

10

r1v8+

D-r3.0+

Seq.
No.

Field Name

1

machine name

2

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-13

All records consist of fields joined by field separators and terminated with a
NEWLINE
character. Each table row describes the following field characteristic:

Seq. No.

Sequence of the fields within the record.

Field Name

Identifies the field.

Type

Identifies field type: character, numeric, date, time, digit
sequence, and logical.

Max. Width

Largest size of the field, in characters.

VOICE MAIL
VERSIONS

Each column identifies which voice mail version(s) the
fields pertain to (appear in the output or are allowed in
the input).

The getmlist command depicted above might retrieve a record, for DEFINITY
AUDIX R1.0 (D-r1.0), that looks like this:
"Seattle","0","audix"

NEWLINE

The machine name is Seattle, the voice id is a 0, and the machine type is an
audix. A callback number is not reported; the table indicates that a callback
number field is output for DEFINITY AUDIX only when ADAP is interacting with
releases D-r3.0 and beyond.
Notice that each field in the output is separated by a comma, the default output
field separator.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-14

Field Types
There are six field types used in the ADAP command line input and output
records.

C (Character)

Set of characters enclosed by delimiters. The default
delimiter is the double quote ("). Any character
(alphabetic, numeric, special character, or blank) may
be in the string. The maximum width column specifies the
maximum number of characters that may be in the
character string.

N (Numeric)

Contains a positive or negative integer or floating point
number. A minus sign (-) precedes a negative number.
The maximum width specifies the largest number of
digits in the field.
If the maximum width for the field contains a decimal
point, this indicates that the numeric field is a floating
point value. For example 3.2 means that there can be up
to three digits before the decimal point and up to two
digits after the decimal.
NOTE:
If numeric data is unavailable from the voice mail system,
the system may place a non-numeric warning string
(such as "Traffic data unavailable") on a numeric field of
the screen that ADAP is attempting to access. Under
these conditions, ADAP is expecting to output a numeric
value when the voice mail platform is providing a
non-numeric string. The ADAP command places a -1 into
the numeric output field instead of any warning string.

D (Date)

8-digit date field, in yyyymmdd format. dd defaults to 01,
if the field provided by the voice mail system does not
include a day-of-month.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-15

T (Time)

4-digit time of day presented in military format hhmm. A
time field does not contain a colon (:) to separate the
hours and minutes. Midnight is represented by 0000.

K (Digit
Sequence)

Contains a string of digits, possible values 0 through 9,
enclosed in delimiters. This field type is usually used for
extensions and mailbox passwords, the numbers that
voice mail subscribers enter to access their mailbox
contents. Since these values are entered on a telephone
keypad , they are identified as field type K. Unlike
numeric fields, leading zeros are valid; unlike character
fields, only digits are valid within the field.

L (Logical)

Contains y or n. Logical fields contain values that answer
yes/no questions or indicate whether particular features
are on or off.

Voice Mail Version Columns
Each table contains columns for the three voice mail systems that ADAP
supports. These columns identify which fields are valid input or expected output
for which system release(s). The information in the table below is an example
only.

Field

Voice Mail Versions
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System
I-r2.0+

Seq.
No.

Field Name

Type

Max.
Width

1

machine name

C

10

r1v2+

D-r1.0+

2

voice id

C

3

r1v2-r1v3

D-r1.0+

I-r2.0+

3

machine type

C

12

r1v4_5+

D-r1.0+

I-r2.0+

4

callback number

K

10

r1v8+

D-r3.0+

There are four types of entries in the voice mail version column: a shaded box, a
single release, a range of releases, or an open ended set of releases.
A shaded box indicates that the field does not apply to any release of the system.
For example, the shaded box shown above means that the field does not exist for
the getmlist command for the INTUITY AUDIX system.
A single release indicates that the field is valid input or output only for that
particular release. The release placed in the table is the value given to the -r
option of the ADAP command.
A range of releases for a particular field means that the field is valid input or
output for any release included in that range. The range is inclusive. For example
of the range that appears in the R1 AUDIX column for the voice id field means the
field appears in the command’s output only when using ADAP with AUDIX
releases r1v2 through r1v3.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-16

The open ended set, is shown by a release number followed by a plus (+) sign.
This means that the particular field is valid input or output for the designated
release and any later, newer releases. An example of an open ended set is the
r1v4_5+ designation appearing in the "machine type" field row of the record
layout table above. This indicates that the machine type will appear in the output
when ADAP is interacting with AUDIX releases r1v4_5 and newer.

Input Records
This section describes record formats and parameters for the input file.

Input File Format
You may process multiple voice mail subscribers by creating an input file
containing information about the subscribers you wish to add, delete, update, or
monitor. This file is then used as input by the data retrieval or modification
command.
Certain commands require that you use valid extensions from the voice mail
system as input. For example, the INTUITY or DEFINITY AUDIX Display
Subscribers screen consists of a different record of data for each subscriber. To
retrieve a record for each of several subscribers, you would enter the extension
number for each subscriber on a separate line in the input file.
Some commands require that you supply only the subscriber extension for the
data that you want to retrieve or modify. The following example shows a list of
extensions, each on a separate line and containing from three to 10 digits. (On
any one voice mail system, all the extensions must be the same length).
"1234567890"
"2345678901"
"9999999999"
"0011100111"
Because the ADAP software treats extensions as characters instead of numbers,
the leading zeroes in 0011100111 are not lost.
Other commands require that you supply additional information to identify
completely the data that you want to retrieve or modify. The following example
requires extension and name for each subscriber, defined by delimiters ("")
each on a separate line and containing from three to 10 digits.
"1234567890","Doe,Mary"
"2345678901","Martinez,Bob"
"9999999999","Green,Sarah"
"0011100111","Jones,David"
Notice that this is the data retrieved by the getdir command. For example, you
could retrieve the subscriber extension and name using getdir then use this data
as input for another command.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-17

NOTE:
When constructing input records for ADAP commands, all fields,
regardless of type, must be enclosed in double quotation marks and
separated by commas. The records must be terminated with a NEWLINE.
These rules hold true whether the input is redirected from a file or entered
interactively from the keyboard though the use of the -i option.

Optional Input Fields
A field name enclosed in square brackets, that is [....], indicates an optional input
field. You do not have to provide a value for this input field when using that
particular ADAP command. If you wish not to provide a value for this input field
but want to give a value for a field later in the input field sequence, you must
insert a placeholder set of double quotes ("") denotes a null string) and a field
separator (a comma) into the input record in the place of this input field.
The null string and comma serve as a placeholder so you can tell ADAP you want
to skip the field and go to a field later in the input sequence. The ADAP command
may then determine the purpose of the value later in the input record. If you wish
to provide a value for the nth input field, you must have provided values or
placeholders for all previous (n-1) fields in the input record. If you wish to omit all
optional fields, you need only provide the required fields; placeholders are not
necessary.
When you omit optional fields, ADAP does not place a value into the
corresponding field on the voice mail form. It allows the voice mail machine to
provide a default value in the case of adding local or remote subscribers. When
changing existing subscribers, omitting optional fields causes the corresponding
information on the voice mail machine to be skipped, leaving intact any value that
may already be there.

Input of Name or Extension
(DEFINITY/INTUITY AUDIX)
Some input records format tables indicate that a name and an extension should
be provided. There is some flexibility when an ADAP is communicating with a
DEFINITY AUDIX or INTUITY AUDIX system. When an ADAP command for a
DEFINITY AUDIX or INTUITY AUDIX system accepts both a name and extension in
an input record, an empty set of double quotes may be placed for either the
name or the extension. Both data items need not be provided.
If only the name is provided, the command uses the name; if only the extension is
provided in the input record, the command uses the extension. If both the name
and extension are specified in an input record, the name is ignored and the
extension is employed in the transaction. For operations which change the name
or extension, these easements apply only to the old name and old extension.
These guidelines do not apply to interactions with R1 AUDIX systems.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-18

Redirecting Input from Files
Once you have constructed an input file, you can use it to retrieve data. For
example, if you wanted to retrieve records for all subscribers on the voice mail
system, using an input file called dir.dat, you could enter the following command.
getsub < dir.dat > sub.dat
Subscriber extension input is supplied to the getsub command from the dir.dat
file. This file contains the extensions of all subscribers on the voice mail system
and has been formatted correctly by the getdir command. The getsub
command (and all other commands requiring a subscriber extension number)
retrieves data for a subscriber when the subscriber’s extension number is
entered. ADAP writes each returned subscriber record to the sub.dat file.

Entering Data from the Keyboard
You may enter data directly from the keyboard by including the -i option on the
command line. To indicate that you have finished entering data while in
interactive mode, press Ctrl-z , followed by RETURN . Ctrl-z is the MS-DOS
end-of-file (EOF) character.
For example:
delsub -i

RETURN

"Doe, John","0123456789"

Ctrl-z

RETURN

Output Records
The following section describes the output record format.

Output Record Format
All data items in output records are separated by an output field separator (OFS).
The default OFS is a comma. All character (C), digit sequence (K), and logical (L)
fields are enclosed in delimiting characters when appearing in output records.
NOTE:
Fields that do not exist for a given release of the voice mail system may be
included in output for compatibility with other releases. Those fields contain
a 0 or "".

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-19

Delimiters
You can change the output character string delimiter from double quotes (") to a
delimiter of your choice. To change the delimiter, set an environment variable
named DLIM to the character you want to use as the delimiter. For example,
enter the following command at the DOS prompt or in the autoexec.bat file.
set DLIM=&
If DLIM is not initialized in this way, the PC system software uses double quotes
(") as the default. For instructions on how to initialize DLIM, see the description of
the autoexec.bat file in your MS-DOS manual.

Output Field Separator
You can use the environment variable OFS, for Output Field Separator, when
communicating with R1 AUDIX systems to specify a single character for
separating the output from the ADAP command line utilities. For example, enter
the following command at the DOS prompt or in the autoexec.bat file.
set OFS=*
Subsequently, an execution of getmlist with an R1V7 may produce output
formatted as follows:
"PERFS1"*"0"*"audix"
"PERFS2"*"29"*"audix"
"PERFT1"*"26"*"audix"
"STL01"*"31"*"audix"
"STS01"*"32"*"audix"
"STT01"*"14"*"audix"
"STT02"*"15"*"audix"
"pluto"*"30"*"audix"
If the OFS is not set, commas are used as output field separators by default. If
the environment variable OFS is set to a character string of length greater than
one, ADAP ignores OFS; and the ADAP commands use commas as separators.
For instructions on how to initialize OFS, see the description of the autoexec.bat
file in your MS-DOS manual. Only commas can be used as the OFS when
communicating with a DEFINITY AUDIX or INTUITY AUDIX system.

Backward Compatibility
In adding features to each release of the voice mail system software, fields have
been added and deleted from the screens with which ADAP interacts. As the
voice mail releases evolves, new fields were added to the end of the ADAP
record formats. If fields have been deleted from any screens in the development
of a new release from a previous one, the ADAP command puts into the output a
placeholding value.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-20

The placeholding value is a zero for numeric fields that have been deleted. For
deleted character, digit sequence or logical fields, the placeholding value is an
empty string enclosed in a set of delimiters (which by default is "").

Redirecting Output to Files
If you don’t specify an output file to receive the data, ADAP displays all retrieved
screens data on the PC screen. Most applications can use the MS-DOS redirect
capability to write the data to a file. To do this, specify an output filename
preceded by a redirect symbol such as > ofile.
For example, if you are retrieving data for the DEFINITY AUDIX or INTUITY List
Extensions screen and you want the data written to a file named dir.dat, enter the
following:
getdir > dir.dat
ADAP retrieves the data from the List Extensions screen for all subscribers on the
DEFINITY AUDIX or INTUITY system and writes it to a file named dir.dat instead of
displaying it on your PC screen.

Using Output with dBASE III PLUS
You can use the output of the ADAP retrieval commands with dBASE III PLUS.
The ADAP retrieval commands have output that places a single record per line.
The data items that make up a record are called fields. For example, the getdir
command outputs a line (a record) for each of the subscribers and that record
consists of fields containing the extension and the name of the particular
subscriber.
The data on these lines is printed in what is called a delimited format; character
field data is enclosed by delimiters (default delimiter is ") and the data items are
separated by commas. This output format is always the same regardless of
whether the command is entered from the MS-DOS prompt, from an MS-DOS
batch file, or from a dBASE III PLUS program. The output always consists of data
written in flat ASCII files or ASCII characters — no binary encoding or
compressing is done.
dBASE III PLUS can use ADAP output and any other files encoded with the
delimited format. If the ADAP retrieval output is redirected to a file, dBASE III
PLUS can read that file.
For example, a file called subs consists of a list of subscriber extensions, one per
line. Executing the following command from the DOS prompt retrieves data about
these subscribers and saves that data in a file called subscr.dat.
getsub < subs > subscr.dat

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Command Line Commands

11-21

The file subscr.dat is in the delimited format. It can be read from within dBASE III
PLUS at the dBASE dot prompt or from a dBASE III PLUS program. From the
dBASE dot prompt, you would type the following:
use sub.dbf
This command causes dBASE III PLUS to use the database structure relevant for
the getsub data. dBASE III PLUS then knows how many fields make up the
records, the field names, whether those fields are to contain numbers, character
strings, dates, etc.
The following dBASE III PLUS command reads the data retrieved from ADAP
saved in subscr.dat, and loads it into the working database.
append from subscr.dat type delimited
The subscriber data for each subscriber initially listed in the input file subs now
exists in a dBASE III PLUS database. The dBASE III PLUS user can sort, search,
do reports, etc., on any of the data returned by the getsub command.

Return Codes
On successful completion, all of the screen retrieval commands exit with a return
code of 0. If processing is not complete when a command terminates, the
commands exits with a non-zero return code. The value of return codes may be
tested from the MS-DOS prompt or using batch programs with the DOS
ERRORLEVEL command.
RS-232 driver errors are shown in Appendix B, "RS-232 Driver Errors".

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Data Retrieval Commands

11-22

Data Retrieval Commands
Database retrieval commands obtain a copy of data from the voice mail system
internal database. The following table lists the voice mail system screens that are
supported and the corresponding retrieval command.
Table 11-1.

Database Retrieval Commands — Screens Correlations

DEFINITY AUDIX/
INTUITY AUDIX Screen Name

R1 AUDIX Screen Name

ADAP
Command

display activity-log

system activity log display

getlog

display administration-log
(DEFINITY only)

system log display

getsys

display administrator’s-log
(INTUITY only)

system log display

getsys

display alarms

maintenance active alarm
display

getaalar

display alarms

maintenance resolved alarm
display

getralar

display cos

class of service

getcos

display errors (DEFINITY only)

maintenance error display

geterror

display events (INTUITY only)

getmaint

display events (DEFINITY only)

getevent

display fragment

getfrag

display remote-subscriber

subscriber remote

getrsub

display subscriber

subscriber local

getsub

display subscriber

system attendant

getsysat

display system-parameters activity-log
display system-parameters features
(D-r1.0)

getalogp
system translation switch
connection

getswitc

display system-parameters
customer-options (D-r2.0+)
display system-parameters features

getsysfe

display system-parameters limits

system limits

getlimit

list attendants

list attendant

getatt

list extensions

list extension local

getdir

Continued on next page

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Data Retrieval Commands

Table 11-1.

11-23

Database Retrieval Commands — Screens Correlations — Continued

DEFINITY AUDIX/
INTUITY AUDIX Screen Name

R1 AUDIX Screen Name

ADAP
Command

list machines

list machine

getmlist

list measurements community day

traffic community day

getcomm

list measurements community hour

traffic community hour

getcomm

list measurements feature day

traffic feature day

getfeat

list measurements feature hour

traffic feature hour

getfeat

list measurements load day

traffic load day

getload

list measurements load hour

traffic load hour

getload

list measurements remote-messages day

traffic remote messages day

getrem

list measurements remote-messages
month

traffic remote messages
month

getrem

list measurements special-features day

traffic special features day

getspfea

list measurements special-features hour

traffic special features hour

getspfea

list measurements subscriber day

traffic subscriber day

gettraf

list measurements subscriber month

traffic subscriber month

gettraf

list remote-extensions

list extension remote

getrlist

list subscribers

list subscriber

getlist

system announcement detail

gettannc

system cdr

getsyscd
get_cdr

system translation machine
adjunct

getadj

list measurements network load day

traffic network load day

getnet

list measurements network load hour

traffic network load hour

getnet

list trusted-servers (INTUITY AUDIX only)

none

getserve

list remote-text-addresses (INTUITY AUDIX
only)

none

gettlist

Continued on next page

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

11 Using the ADAP Command Line Language
Database Modification Commands

11-24

Database Modification Commands
You use database modification commands to modify certain data directly in the
voice mail database. The following table provides you with the name of each
modification command, its purpose, and the voice mail system software versions
for which the commands can be used. All commands are described in Chapter
13, "Command Line Database Modification Commands", in alphabetical order.
Table 11-2.

Database Modification Commands

Purpose

Command

Voice Mail Version

Add remote subscriber

addrsub

All

Add subscriber

addsub

D-r1.0+, r1v3+, I-r2.0+

Change covering extension

changcex

All

Change community id

changcom

D-r1.0+, r1v5+, I-r2.0+

Change class of service

changcos

All

Change subscriber extension

changext

All

Change miscellaneous field

changmis

All

Change priority message

changmsg

D-r1.0+, r1v5+, I-r2.0+

Change subscriber attributes

changsub

D-r1.0+, r1v6+, I-r2.0+

Change subscriber name

changnam

All

Change password

changpwd

All

Change switch number

changsw

All

Change text-service machine user ID

changtex

r1v4+

Change remote subscriber community id

chgrcom

All

Change remote subscriber extension

chgrext

All

Change remote subscriber machines

chgrmach

All

Change remote subscriber names

chgrnam

All

Delete remote subscribers

delrsub

All

Set system translation machine adjunct

setadj

r1v5+

Set activity log values

setalogp

D-r2.0+, I-r2.0+

Set system cdr screen data

setscdr

r1v5+

Continued on next page

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
Overview

12-1

Command Line Database Retrieval
Commands

12

Overview
For each of the following commands, this chapter provides the syntax, a
description, errors, output format, and an example.
getaalar

getfrag

getrsub

getadj

getlimit

getserve

getalogp

getlist

getspfea

getannc

getsub

getatt

getlog

getswitc

get_cdr

getmaint

getsys

getcomm

getmlist

getsysat

getcos

getnet

getsyscd

getdir

getperf

getsysfe

geterror

getralar

gettlist

getevent

getrem

gettraf

getfeat

getrlist

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getaalar

12-2

getaalar
Get active alarm list

Syntax
getaalar [-d mmddyy] [-t hhmm] [-M y/n] [-m y/n] [-W y/n] [-T resource-type]
[-L location] [-n nnnn] [-u unit] [-l level] [-p nn] [-c fault/alarm code]
[-A application] [-r release] [-v] [-w] [-V > ofile]

Description
This command retrieves all pages of the following screens, for the search
information that you specify:
■

INTUITY AUDIX Display Alarms

■

DEFINITY AUDIX Display Alarms

■

R1 AUDIX maintenance : active alarm : display

For INTUITY and DEFINITY AUDIX Systems, ADAP updates the specification fields
of the Display Alarms screen while retrieving the data. For the R1 AUDIX System,
ADAP updates the maintenance : active alarms : specification screen before
retrieving the screen data. The voice mail system retains the values you supply
after the retrieval is completed.
If you omit the options and their qualifiers (for example, unit, level, and fault/alarm
code), then all active alarms are returned.
For complete lists of units, resource types and fault/alarm codes, see the
appropriate voice mail system maintenance manual.
No input is required. All active alarms retrieved are written to standard output

-d

Date flag; must be followed by mmddyy. This flag is available
only for the INTUITY and DEFINITY AUDIX Systems. The default
is to retrieve data for all dates.

mmddyy

Retrieves data starting at the month, day, and year indicated
by mmddyy. For example, 112294 retrieves data starting on
November 22, 1994.

-t

Day flag: must be followed by hhmm. This flag is only available
if the d flag also is specified. This flag is only available with the
INTUITY and DEFINITY AUDIX Systems. The default is to retrieve
all data starting at the current date.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getaalar

12-3

hhmm

Retrieves errors from the specified hour and minute to the
current time. For example, if you enter 1512 at 6:00 p.m. (for
retrieval on the same day), the data from 3:12 p.m. to 6:00 p.m.
will be retrieved. Midnight is represented by 0000.

-T

Resource type flag; must be followed with resource-type. This
flag is only for the INTUITY and DEFINITY AUDIX Systems. The
default is to retrieve entries for all resource-types.

resource
type

Retrieves alarms logged against the resource type that you
specify. See the appropriate voice mail system maintenance
manual for a list of resource types.

-L

Location flag; must be followed with location. This flag is only
available with the INTUITY and DEFINITY AUDIX Systems. The
default is to retrieve entries for all locations.

location

Retrieves errors logged against resources at the specified
location. For the DEFINITY AUDIX System, the T resource-type
argument also must be specified. See the appropriate voice
mail system forms reference manual for the format of location.

-M

Major alarm flag; must be followed by either a y or n, indicating
whether or not to retrieve major alarms. This flag is only
available with the INTUITY and DEFINITY AUDIX Systems. The
default is y.

y/n

Retrieves or does not retrieve major alarms.

-m

Minor alarm flag; must be followed by either a y or n, indicating
whether or not to retrieve minor alarms. This flag is only
available with the INTUITY and DEFINITY AUDIX Systems. The
default is y.

y/n

Retrieves or does not retrieve minor alarms.

-W

Warning alarm flag; must be followed by either a y or n,
indicating whether or not to retrieve warning alarms. This flag is
only available with the INTUITY and DEFINITY AUDIX Systems.
The default is y.

y/n

Retrieves or does not retrieve warning alarms.

-n

Number flag; must be followed by nnnn. This flag is only
available with the INTUITY and DEFINITY AUDIX Systems.

nnnn

Retrieves the number (nnnn) of alarm entries that you specify.
The default is to retrieve all entries that match the
specifications.

-u

Hardware unit flag: must be followed by unit. This flag is only
available with R1 AUDIX Systems.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getaalar

12-4

unit

Retrieves alarms logged against the hardware unit that you
specify. See the appropriate voice mail system maintenance
manual for a list of units.

-l

Severity level number; must be followed by level. This flag is
only available with the R1 AUDIX System.

level

Retrieves alarms logged with the severity level you specify (0 =
major, 1 = minor, and 2 = warning).

-c

Fault/alarm code number flag: must be followed by fault/alarm
code.

fault/alarm
code

Retrieves alarms logged with the specific fault/alarm code.
(Fault code for DEFINITY AUDIX and R1 AUDIX Systems; alarm
code for the INTUITY AUDIX System.) See the appropriate voice
mail system maintenance manual for a list of fault/alarm codes.

-A

Application flag; must be followed by application. This flag is
only available with the INTUITY AUDIX System.

application

Retrieves only records logged against this application
(module), i.e. VM. See the Lucent INTUITY Platform
Administration and Maintenance Manual for a list of
applications.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX System software. The DEFINITY
AUDIX System default is D-r3.2. The INTUITY AUDIX System
default is I-r5.0.

-p

Alarm page number flag: must be followed by nn. This flag is
available only for the R1 AUDIX System.

nn

Retrieves the number (nn) of alarm pages that you specify.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command
into the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The file
name must be preceded by the symbol > . If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getaalar

12-5

Errors
If no active alarms exist that fit the specified search, no output is written.

! CAUTION:
R1AUDIX System only. If operators on the local maintenance terminal (LMT)
and the local administration terminal (LAT) concurrently access the same
screen information, output on either terminal could prematurely terminate or
reflect other undesirable changes.

Output Format
Output for the getaalar command when communicating with a DEFINITY or
INTUITY AUDIX System is as follows, with one record for each alarm.

FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

10

D-r1.0+

I-r2.0+

11

D-r1.0+

I-r2.0+

C

3

D-r1.0+

I-r2.0+

fault/alarm code

N

4

D-r1.0+

I-r2.0+

5

acknowledge

C

1

D-r1.0+

I-r2.0+

6

data alarmed

D

8

D-r1.0+

I-r2.0+

7

time alarmed

T

4

D-r1.0+

I-r2.0+

8

date resolved

D

8

D-r1.0+

I-r2.0+

9

time resolved

T

4

D-r1.0+

I-r2.0+

10

resolve reason

C

6

D-r1.0+

I-r2.0+

11

application

C

2

Seq.
No.

Field Name

Type

Max.
Width

1

resource type

C

2

location

C

3

alarm level

4

R1
AUDIX
System

I-r2.0+

Output for the getaalar command when communicating with an R1 AUDIX
System is as follows, with one record for each alarm

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

D

8

r1v2+

time

T

4

r1v2+

3

fault

N

4

r1v2+

4

level

N

1

r1v2+

5

unit

N

3

r1v2+

6

device

N

2

r1v2+

Seq.
No.

Field Name

1

date

2

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getaalar

12-6

Example
The following command retrieves the INTUITY or DEFINITY AUDIX Display Alarms
screen data, writes a summary of the transfer statistics to the screen, and writes
output to a file named alarms.
getaalar -v > aalarms

RETURN

The following data is written to the file:
"ALARM_BD","01B07"","MIN",0,"n",19941128,1436,,,""
NEWLINE

This example shows one line of output. However, the command can return many
lines of data.
The following command retrieves the R1 AUDIX maintenance : active : alarm :
specification screen data, writes a summary of the transfer statistics to the
screen, and writes output to a file named aalarms.
getaalar -r r1v8 -v > aalarms

RETURN

The following data is written to the file:
19950121,0849,73,0,116,0

NEWLINE

This example shows one line of output. However, the command can return many
lines of data.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getadj

12-7

getadj
Get adjunct machine translation data

Syntax
getadj -m machine -r release [-v] [-w] [-V] [> ofile]

Description
This command retrieves the R1 AUDIX (R1V5 and beyond) system : translation :
machine : adjunct screen data for the machine specified in the command
options.
No input is required. Retrieved data is written to standard output.

-m

Machine flag; must be followed by machine.

machine

Retrieves data for the specified machine. If the machine name is
more than one word (such as "new york"), the name must be
enclosed in quotation marks.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the R1 AUDIX System
software (R1V5 and beyond). The default is D-r3.2.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

Errors
An error message appears on the screen if you use this command with the
INTUITY or DEFINITY AUDIX Systems, or the R1 AUDIX System prior to R1V5. An
error message also appears if you enter an invalid machine name.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getadj

12-8

Output Format
Output for the getadj command is formatted as follows.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

C

10

r1v5+

password

C

10

r1v5+

3

machine type (c/t)

C

1

r1v5+

4

network connection type

C

6

r1v5+

5

data rate

N

5

r1v5+

6

channel

C

1

r1v5+

7

dial string

C

65

r1v5+

8

schedule 1 start hour

N

2

r1v5+

9

schedule 1 start minute

N

2

r1v5+

10

schedule 1 end hour

N

2

r1v5+

11

schedule 1 end minute

N

2

r1v5+

12

schedule 1 interval hour

N

2

r1v5+

13

schedule 1 interval minute

N

2

r1v5+

14

schedule 2 start hour

N

2

r1v5+

15

schedule 2 start minute

N

2

r1v5+

Seq.
No.

Field Name

1

machine name

2

16

schedule 2 end hour

N

2

r1v5+

17

schedule 2 end minute

N

2

r1v5+

18

schedule 2 interval hour

N

2

r1v5+

19

schedule 2 interval minute

N

2

r1v5+

20

schedule 3 start hour

N

2

r1v5+

21

schedule 3 start minute

N

2

r1v5+

22

schedule 3 end hour

N

2

r1v5+

23

schedule 3 end minute

N

2

r1v5+

24

schedule 3 interval hour

N

2

r1v5+

25

schedule 3 interval minute

N

2

r1v5+

26

purge text service queue

L

1

r1v5+

27

new machine name

C

10

r1v5+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getadj

12-9

Example
The following command retrieves the R1 AUDIX system : translation : machine :
adjunct screen data, writes a summary of the transfer statistics to the screen, and
writes output to a file named adjdata.
getadj -m miami -r r1v8 -v > adjdata

RETURN

The following data is written to the file:
"miami","","c","dcp",19200,"0","13052258330",0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,"n","" NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getalogp

12-10

getalogp
Get activity log data

Syntax

getalogp [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves the following main screens:
■

INTUITY AUDIX Display System-Parameters Activity-Log

■

DEFINITY AUDIX Display System-Parameters Activity-Log

No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX or
DEFINITY AUDIX System software. The default for the DEFINITY
AUDIX System is D-r3.2. The default for the INTUITY AUDIX System
is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol > . If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getalogp

12-11

Errors
If you use this command with an R1 AUDIX System, an error message appears
on the screen.

Output Format
Output for the getalogp command when communicating with an INTUITY AUDIX
System and DEFINITY AUDIX System is formatted as follows, with one record for
each activity log entry.

FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

1

D-r1.0+

I-r2.0+

L

1

D-r1.0+

I-r2.0+

N

5

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

Type

Max.
Width

1

activity log enabled

L

2

recording MWI updates

3

max number of activity log entries

R1
AUDIX
System

Example
The following command retrieves the Display System-Parameters Activity-Log
data, writes a summary of the transfer statistics to the screen, and writes output
to a file named activity.
getalogp -v > activity

RETURN

The following data is written to the file:
"y","n",10000

NEWLINE

This example shows one line of output. This command always returns only a
single line of data.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getannc

12-12

getannc
Get system announcement data

Syntax
getannc -f fragment number [-n nnnn] -r release [-v] [-w] [-V] [ > ofile]

Description
This command retrieves the following screens for the fragment number from the
active announcement set that you specify:
■

R1 AUDIX (R1V3 and beyond) system : announcement : detail

No input is required. Retrieved data is written to standard output.
-f

Fragment number flag; must be followed by the fragment number.

fragment
number

Retrieves data for the specified fragment number. Fragment
numbers are displayed in Appendix E of AUDIX Administration,
585-305-501.

-n

Fragment number flag; must be followed by nnnn.

nnnn

Retrieves the number (nnnn) of fragment records that you specify.
For example, if you enter 5 for nnnn and you have requested
-f 86, fragment information for fragments 86 through 90 will be
displayed.

-r

Indicates that the argument following is the name of the release.
This argument must be followed by release.

release

Retrieves data for the specified release of the R1 AUDIX (R1V3
and beyond) System software. The default is D-r3.2.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data appears on the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getannc

12-13

Errors
If you try to use this command with the INTUITY or DEFINITY AUDIX Systems, or
with AUDIX R1V2 System, an error message appears.

Output Format
Output for the getannc command is as follows, with one record for each
fragment.
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

C

19

r1v3+

C

19

r1v3+

Seq.
No.

Field Name

1

filesystem name

2

active announcement data filesystem

3

admin announcement data filesystem

C

19

r1v3+

4

announcement number

N

4

r1v3+

5

announcement modified

L

1

r1v3+

6

announcement composition

C

55

r1v3+

7

fragment number

N

4

r1v3+

8

fragment issue

N

4

r1v3+

9

fragment modified

L

1

r1v3+

10

x to remove fragment

C

1

r1v3+

11

fragment size

N

5

r1v3+

12

cached

L

1

r1v3+

13

hit rate

N

3

r1v3+

14

copy from filesystem

C

19

r1v3+

15

copy from fragment number

N

4

r1v3+

16

measure fragment hit rate

L

1

r1v3+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Example
The following command retrieves the system : announcement : detail screen data
for one fragment, writes a summary of the transfer statistics to the screen, and
writes output to a file named frag86.
getannc -f 86 -r r1v8 -v > frag86

RETURN

The following data is written to the file:
"","disk10.V5ana457","",0,"","",86,1,"n","",1600,0,0,
"",0,0 NEWLINE
NOTE:
Field 12, cached , and Field 16, measure fragment hit rate, are reported as
numeric zero for the AUDIX R1V5 System and beyond.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getatt

12-14

getatt
Get attendant list

Syntax
getatt [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves all pages for the following screens:
■

INTUITY AUDIX List Attendants

■

DEFINITY AUDIX List Attendants

■

R1 AUDIX (R1V3 and beyond) list : attendant

No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) System
software. The default for the DEFINITY AUDIX System is D-r3.2. The
default for the INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exists
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

Errors
If you try to use this command with an AUDIX R1V2 System, an error message
appears.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getatt

12-15

Output Format
Output for the getatt command is formatted as follows with one record for each
attendant.

FIELD

Seq.
No.

Field Name

1

attendant extension

2

name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

K

10

r1v3+

D-r1.0+

I-r2.0+

C

29

r1v3+

D-r1.0+

I-r2.0+

Example
The following command retrieves the INTUITY or DEFINITY AUDIX System List
Attendants screen data for all the system attendants, writes a summary of the
transfer statistics to the screen, and writes output to a file named attend. The
output is the same for the AUDIX R1V8 System, except the -r r1v8 option must
be specified.
getatt -v > attend

RETURN

The following data is written to the file, one line for each attendant:
"60099","Main Attendant"

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
get_cdr

12-16

get_cdr
Get Call Detail Recording data

Syntax
get_cdr -d device [-b baud rate] [-l modem initialization string ]
[-p communications port] [-m stop date -h stop time] [-c] [-i] [-t]
[-v] [-w] [-V] [-r release PC_name AUDIX_password AUDIX_name
[phone number]] [> ofile]

Description
NOTE:
To use this command, you must have the separately-purchased Call Detail
Recording (CDR) software for R1 AUDIX System (R1V5 and beyond).
No input is required. Retrieved data is written to a file created by the software
with the naming convention mmddyy_ .cdr, where mmddyy is the creation
date and  represents the file’s sequential status among .cdr files created
on that date, such as 110294_a.cdr and 110294_b.cdr.

-d

Device type flag; must be followed by device.

device

Valid types are pdm (MPDM data modules), hayes
(Hayes-compatible modems), AT&T 4000, and direct (direct
cable connection).

-b

Baud rate flag; must be followed by a transfer baud rate.

baud rate

Valid transfer baud rates are 1200, 2400, 4800, 9600, and
19200. If no baud rate is specified, the default (4800) is used.

-p

Communications port number flag; must be followed by a
communications port number.

communications port

Communications port number of the PC. Valid port numbers are
1 (COM1) and 2 (COM2). If no port is specified, the default (2) is
used.

-m

Stop date flag; must be followed by a stop date and the -h stop
time.

stop date

Specifies the stop date for retry attempts. Dates must be in the
format mm/dd/yy with leading zero’s included.

-h

Stop time flag; must be followed by a stop time and preceded by
the -m stop date.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
get_cdr

12-17

stop time

Specifies the stop time for retry attempts. Times must be in the
format hh:mm using a 24-hour clock with leading zero’s
included. Midnight is represented by 00:00.

-I

Modem initialization string flag.

modem
initialization
string

Specifies an initialization string to be sent to the modem before
connection to the voice mail system is attempted. The default is
a null string.

-i

Specifies for the system to bypass the search for the Data Set
Ready (DSR) signal. Use this option only with Hayes-compatible
modems.

-c

Checks to see if you have purchased CDR or not; no off-load is
attempted. This option cannot be used with any other options.

-t

Causes the modem loop-around test to be performed. No
off-load is attempted.

-w

Writes a one-line summary of the exit status of this command into
the file getcdr.rc and writes the status to the ADAP event log.

-v

Writes verbose status information to the screen as a debugging
aid.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the R1 AUDIX (R1V5
and beyond) software. The default is D-r3.2.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

PC_name

Identifies the PC’s network name as administered by the
R1 AUDIX System using the system : translation : machine :
adjunct screen.

AUDIX_
password

Identifies the R1 AUDIX password as administered using the
system : translation : machine : audix screen.

AUDIX_
name

Identifies the local R1 AUDIX System name as administered on
the system : translation : machine : audix screen.

phone
number

Identifies the R1 AUDIX network port phone number. This
number is not required for direct cable connections. If using a
Hayes-compatible or AT&T 4000 modem, enter t in front of the
phone number for touch-tone dialing.

> ofile

Specifies the name of the file where status information about the
data transfer is written. The filename must be preceded by the
symbol >. If no output file is specified, status information
appears on the screen. (The actual retrieved data is written to a
file created by the software, as described on the previous page.)

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
get_cdr

12-18

If you specify an invalid option or omit a required option, you see following
message; if this happens, check your options and reenter the command:

The I feature sends initialization strings to Hayes and Hayes-compatible
modems. However, you may use the I option to send a startup string to any local
connection-establishing device, such as a PDM or modem, that returns the string
"OK" to the computer after processing and acting on a valid string.
The get_cdr command does not check the validity of the initialization string but
counts on the connection device returning an "OK" to the COM1 or COM2 port
when the device is successful in using the string. Spaces are legal in Hayes
initialization strings. If you use strings containing spaces with this I option,
enclose the string in double quotes when following the I on the command line.

Errors
An error message appears on the screen if you try to use this command with the
INTUITY or DEFINITY AUDIX Systems, or R1 AUDIX R1V2 through R1V4.5.

Output Format
AUDIX Call Detail Recording Package, 585-305-506, describes CDR records.

Example
The following command retrieves the Call Detail Recording data.
get_cdr -d pdm -r r1v8 -m 10/19/94 -h 13:00 -v pc1 pass1 aud1 7413
RETURN

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcomm

12-19

getcomm
Get community measurement data

Syntax
getcomm -f day [-d mmddyy] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]
or
getcomm -f hour [-d mmddyy] [-t hh] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves the following screens for the date that you specify:
■

INTUITY AUDIX List Measurements Community Day

■

DEFINITY AUDIX List Measurements Community Day

■

R1 AUDIX (R1V5 and beyond) traffic : community : day

This command retrieves the following screens for the date and time that you
specify:
■

INTUITY AUDIX List Measurements Community Hour

■

DEFINITY AUDIX List Measurements Community Hour

■

R1 AUDIX (R1V5 and beyond) traffic : community : hour

-f

Indicates that the argument following is a screen. This flag must be
followed by either day or hour.

day

Retrieves the day version of the screen.

hour

Retrieves the hour version of the screen.

-d

Date flag; must be followed by mmddyy. Date is required when
used with the R1 AUDIX System. If this flag is omitted, the most
recent date’s data will be returned.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 112294 without subsequently entering the
n option, only the data for November 22, 1994, will be retrieved.

-t

Time of the day flag; must be followed by hh. This flag is required
when used with the R1 AUDIX System. If this flag is omitted, the first
hour (hour 0) of the specified day or the current hour (if no day is
specified) will be returned.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcomm

12-20

hh

Retrieves data for the hour of the day that you have specified
already by mmddyy. For example, if you enter 15 without
subsequently entering the n option, the system retrieves only the
data from 3:00 p.m. to 4:00 p.m.

-n

Number of records flag; must be followed by nn.

nn

Retrieves the number (nn) of hourly or daily records that you
specify. If you don’t include this flag, only one record (hour or day)
will be returned.
For example, if you want to retrieve hourly data and you enter 15 for
hh and then enter 5 for nn, the system retrieves the data for the
hours between 3:00 p.m. and 8:00 p.m. (the data beginning at 3:00
and continuing through the next five hours). The same is true for
daily records. If you enter 112294 for mmddyy and then enter 8 for
nn, the system retrieves the data from and including November 22,
1994, and continuing through November 29, 1994.
For the INTUITY and DEFINITY AUDIX Systems, you may use the
value all to retrieve all records (hour or day) on or after any
specified date and time.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V5 and beyond) software. The
default for the DEFINITY AUDIX System is D-r3.2. The default for
the INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol > . If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcomm

12-21

Errors
If you use this command with a version earlier than R1V5, an error message
appears.
If either the date or time is invalid when communicating with an R1 AUDIX
System, the retrieval aborts and no records are written.
If the specified date is earlier than any valid date on an INTUITY or DEFINITY
AUDIX System, the retrieval starts at the first date with data. If the specified date
is after a valid date, an error message appears and the retrieval aborts.

Output Format
Output for the getcomm command when using the -f day option is formatted as
follows, with one record for each day.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

D

8

r1v5+

D-r1.0+

I-r2.0+

ending time

T

4

r1v5+

D-r1.0+

I-r2.0+

3

VM msgs sent by comm 1

N

7

r1v5+

D-r1.0+

I-r2.0+

4

VM msgs received by comm 1

N

7

r1v5+

D-r1.0+

I-r2.0+

5

VM msgs not sent by comm 1

N

7

r1v5+

D-r1.0+

I-r2.0+

6

VM msgs not received by comm 1

N

7

r1v5+

D-r1.0+

I-r2.0+

7

VM msgs sent by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

8

VM msgs received by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

9

VM msgs not sent by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

10

VM msgs not received by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

11

VM msgs sent by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

12

VM msgs received by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

13

VM msgs not sent by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

1

starting date

2

14

VM msgs not received by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

15

VM msgs sent by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

16

VM msgs received by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

17

VM msgs not sent by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

18

VM msgs not received by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

19

VM msgs sent by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

20

VM msgs received by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

21

VM msgs not sent by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

22

VM msgs not received by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

23

VM msgs sent by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

24

VM msgs received by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

25

VM msgs not sent by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcomm

12-22
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

26

VM msgs not received by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

27

VM msgs sent by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

28

VM msgs received by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

29

VM msgs not sent by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

30

VM msgs not received by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

31

VM msgs sent by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

32

VM msgs received by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

33

VM msgs not sent by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

34

VM msgs not received by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

35

VM msgs sent by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

36

VM msgs received by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

37

VM msgs not sent by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

38

VM msgs not received by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

39

VM msgs sent by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

40

VM msgs received by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

41

VM msgs not sent by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

42

VM msgs not received by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

43

VM msgs sent by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

44

VM msgs received by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

45

VM msgs not sent by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

46

VM msgs not received by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

47

VM msgs sent by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

48

VM msgs received by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

49

VM msgs not sent by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

50

VM msgs not received by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

51

VM msgs sent by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

52

VM msgs received by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

53

VM msgs not sent by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

54

VM msgs not received by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

55

VM msgs sent by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

56

VM msgs received by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

57

VM msgs not sent by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

58

VM msgs not received by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

59

VM msgs sent by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

60

VM msgs received by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

61

VM msgs not sent by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

62

VM msgs not received by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

Output for the getcomm command when using the -f hour option is formatted as
follows, with one record for each hour.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcomm

12-23

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

8

r1v5+

D-r1.0+

I-r2.0+

2

r1v5+

D-r1.0+

I-r2.0+

4

r1v5+

D-r1.0+

I-r2.0+

7

r1v5+

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

1

starting date

D

2

starting hour

N

3

ending time

T

4

VM msgs sent by comm 1

N

5

VM msgs received by comm 1

N

7

r1v5+

D-r1.0+

I-r2.0+

6

VM msgs not sent by comm 1

N

7

r1v5+

D-r1.0+

I-r2.0+

7

VM msgs not received by comm 1

N

7

r1v5+

D-r1.0+

I-r2.0+

8

VM msgs sent by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

Type

Max.
Width

9

VM msgs received by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

10

VM msgs not sent by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

11

VM msgs not received by comm 2

N

7

r1v5+

D-r1.0+

I-r2.0+

12

VM msgs sent by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

13

VM msgs received by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

14

VM msgs not sent by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

15

VM msgs not received by comm 3

N

7

r1v5+

D-r1.0+

I-r2.0+

16

VM msgs sent by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

17

VM msgs received by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

18

VM msgs not sent by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

19

VM msgs not received by comm 4

N

7

r1v5+

D-r1.0+

I-r2.0+

20

VM msgs sent by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

21

VM msgs received by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

22

VM msgs not sent by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

23

VM msgs not received by comm 5

N

7

r1v5+

D-r1.0+

I-r2.0+

24

VM msgs sent by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

25

VM msgs received by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

26

VM msgs not sent by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

27

VM msgs not received by comm 6

N

7

r1v5+

D-r1.0+

I-r2.0+

28

VM msgs sent by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

29

VM msgs received by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

30

VM msgs not sent by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

31

VM msgs not received by comm 7

N

7

r1v5+

D-r1.0+

I-r2.0+

32

VM msgs sent by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

33

VM msgs received by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

34

VM msgs not sent by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

35

VM msgs not received by comm 8

N

7

r1v5+

D-r1.0+

I-r2.0+

36

VM msgs sent by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

37

VM msgs received by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

38

VM msgs not sent by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

39

VM msgs not received by comm 9

N

7

r1v5+

D-r1.0+

I-r2.0+

40

VM msgs sent by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcomm

12-24
FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

41

VM msgs received by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

42

VM msgs not sent by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

43

VM msgs not received by comm 10

N

7

r1v5+

D-r1.0+

I-r2.0+

44

VM msgs sent by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

45

VM msgs received by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

46

VM msgs not sent by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

47

VM msgs not received by comm 11

N

7

r1v5+

D-r1.0+

I-r2.0+

48

VM msgs sent by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

49

VM msgs received by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

50

VM msgs not sent by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

51

VM msgs not received by comm 12

N

7

r1v5+

D-r1.0+

I-r2.0+

52

VM msgs sent by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

53

VM msgs received by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

54

VM msgs not sent by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

55

VM msgs not received by comm 13

N

7

r1v5+

D-r1.0+

I-r2.0+

56

VM msgs sent by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

57

VM msgs received by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

58

VM msgs not sent by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

59

VM msgs not received by comm 14

N

7

r1v5+

D-r1.0+

I-r2.0+

60

VM msgs sent by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

61

VM msgs received by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

62

VM msgs not sent by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

63

VM msgs not received by comm 15

N

7

r1v5+

D-r1.0+

I-r2.0+

Type

Max.
Width

R1
AUDIX
System

Seq.
No.

Example
The following command retrieves the INTUITY or DEFINITY AUDIX List
Measurements Community Day screen data for January 19, 1995, writes a
summary of the transfer statistics to the screen, and writes output to a file named
commtraf. The output is the same for R1V5 and beyond, but you must specify the
release version on the command line.
getcomm -f day -d 011995 -v > commtraf

RETURN

The following data is written to the file:
19950119,2359,3250,3173,960,0,2394,5731,0,960,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcos

12-25

getcos
Get classes of service data

Syntax

getcos [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves the following screens:
■

INTUITY AUDIX Display Cos

■

DEFINITY AUDIX Display Cos

■

R1 AUDIX Class of Service

No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX software. The default for the
DEFINITY AUDIX System is D-r3.2. The default for the INTUITY AUDIX
System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

Errors
No errors are associated with this command.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcos

12-26

Output Format
Output for the getcos command is formatted as follows, with one record per
class-of-service.

FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

1

class-of-service

C

8

r1v2+

D-r1.0+

I-r2.0+

2

modified

L

1

r1v2+

D-r1.0+

I-r2.0+

3

addressing format

C

9

r1v2+

D-r1.0+

I-r2.0+

4

CA permissions

C

14

r1v2+

D-r1.0+

I-r2.0+

5

announcement control

C

1

r1v2+

D-r1.0+

I-r2.0+

6

incoming mailbox LIFO/FIFO

C

4

r1v2+

D-r1.0+

I-r2.0+

7

incoming mailbox order

C

3

r1v2+

D-r1.0+

I-r2.0+

8

new retention time

N

3

r1v2+

D-r1.0+

I-r2.0+

9

old retention time

N

3

r1v2+

D-r1.0+

I-r2.0+

10

unopened retention time

N

3

r1v2+

D-r1.0+

I-r2.0+

11

outgoing mailbox LIFO/FIFO

C

4

r1v2+

D-r1.0+

I-r2.0+

12

outgoing mailbox order

C

5

r1v2+

D-r1.0+

I-r2.0+

13

file cabinet retention time

N

3

r1v2+

D-r1.0+

I-r2.0+

14

del/non del retention time

N

3

r1v2+

D-r1.0+

I-r2.0+

15

max VM message length

N

4

r1v2+

D-r1.0+

I-r2.0+

16

min VM space required

N

4

r1v2+

D-r1.0+

I-r2.0+

17

max CA message length

N

4

r1v2+

D-r1.0+

I-r2.0+

18

min CA space required

N

4

r1v2+

D-r1.0+

I-r2.0+

19

max number of mailing lists

N

3

r1v2+

D-r1.0+

I-r2.0+

20

max total mailing list entries

N

5

r1v2+

D-r1.0+

I-r2.0+

21

max mailbox size

N

5

r1v2+

D-r1.0+

I-r2.0+

22

guaranteed space

N

4

r1v2+

D-r1.0+

I-r2.0+

23

outcalling

L

1

r1v3+

D-r1.0+

I-r2.0+

24

priority messages

L

1

r1v5+

D-r1.0+

I-r2.0+

25

broadcast permissions

C

5

r1v5+

D-r1.0+

I-r2.0+

26

end of message warning time

N

2

r1v6+

D-r1.0+

I-r2.0+

27

ca language choice

L

1

D-r3.0+

I-r3.2+

28

login announcement set

C

14

D-r3.0+

I-r3.2+

29

ca primary announcement set

C

14

D-r3.0+

I-r3.2+

30

ca secondary announcement set

C

14

D-r3.0+

I-r3.2+

31

IMAPI access

L

1

D-r3.1+

I-r3.2+

32

IMAPI voice file/message transfer

L

1

D-r3.1+

33

FAX creation

L

1

I-r3.3+

34

trusted server access

L

1

I-r4.0+

I-r3.2+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getcos

12-27

Example
The following command retrieves all of the DEFINITY AUDIX Class of Service
screens, writes a summary of the transfer statistics to the screen, and writes
output to a file named options.
getcos -v > options

RETURN

The following data is written to the file, one line for each class of service:
"class00","n","extension","call-answer","n","fifo",
"nuo",10,10,10,"fifo","ufdan",10,5,300,32,120,8,25,250,
1200,0, "n","n","none",10,"y","standard","french-1",
"lat-span","n","n" NEWLINE
The following command retrieves all of the AUDIX R1V8 Class of Service
screens, writes a summary of the transfer statistics to the screen, and writes
output to a file named options.
getcos -v -r r1v8 > options

RETURN

The following data is written to the file, one line for each class of service:
"def","n","e","c","n","f","nuo",10,10,10,"f","funda",
10,5,200,120,120,40,25,250,1200,0,"","n","n",10
NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getdir

12-28

getdir
Get local extension list

Syntax

getdir [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves all pages of the following screens:
■

INTUITY AUDIX List Extensions

■

DEFINITY AUDIX List Extensions

■

R1 AUDIX list : extension : local

No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX software. The default for the
DEFINITY AUDIX System is D-r3.2. The default for the INTUITY
AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getdir

12-29

Errors
No errors are associated with this command.

! CAUTION:
The following caution only applies when connected to an AUDIX System:
If operators on the local maintenance terminal (LMT) and the local
administration terminal (LAT) concurrently access the same screen
information, output on either terminal could prematurely terminate or reflect
other undesirable changes.

Output Format
Output for the getdir command is formatted as follows, with one record for each
local subscriber.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

name

C

29

r1v2+

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

1
2

Example
The following command retrieves the List Extensions screen data for all INTUITY or
DEFINITY AUDIX System subscribers, writes a summary of the transfer statistics
to the screen, and writes output to a file named extens.
getdir -v > extens

RETURN

The following data is written to the first line of the file.
"67890","Doe, John"

NEWLINE

One line for each subscriber appears in the file.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
geterror

12-30

geterror
Get maintenance error data

Syntax
geterror [-d mmddyy [-t hhmm]] [-c error code] [-f search string ]
[-s session] [-R reporting-resource-type] [-T resource-type [-L location]]
[-n nnnn] [-m module] [-D device] [-x y/n]
[-p nn] [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves all pages for the date, time, and search information that
you specify for the following screens:
■

DEFINITY AUDIX Display Errors

■

R1 AUDIX maintenance : error : display

ADAP updates the specification fields of the DEFINITY AUDIX Display Errors
screen while retrieving the data, or updates the maintenance : error :
specification screen before retrieving the screen data, The voice mail system
retains the values you supply after the retrieval is completed.
If you omit the options and their qualifiers (for example; session, module, device),
then all errors from and including the specified date and time are returned.
For complete lists of errors, sessions, modules, devices, reporting module types,
and resource types, see the appropriate voice mail system maintenance manual.
NOTE:
The geterror command requires the craft login for DEFINITY AUDIX
System.
No input is required. All errors retrieved are written to standard output.

-d

Date flag; must be followed by mmddyy. This flag is required for
AUDIX Systems. The default retrieves entries for all dates.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 112294, the data for November 22, 1994,
is retrieved.

-t

Time of the day flag; must be followed by hhmm. This flag is
required for AUDIX Systems. The default retrieves all entries
starting at the specified date.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
geterror

12-31

hhmm

Retrieves errors from the specified hour and minute to the current
time. For example, if you enter 1512 at 6:00 p.m. (for retrieval on the
same day), the data from 3:12 p.m. to 6:00 p.m. will be retrieved.
Midnight is represented by 0000.

-c

Error code flag; must be followed by error code. (This flag was e in
previous ADAP versions.)

error code

Retrieves errors matching the error code that you specify. See the
appropriate voice mail system maintenance manual for a list of
errors.

-f

Search string flag; must be followed by search string .

search
string

Retrieves errors containing the search string you specify. The
maximum string length is 50 characters.

-s

Software session number flag; must be followed by session.

session

Retrieves errors logged by the software session number that you
specify. See the appropriate voice mail system maintenance
manual for a list of sessions.

-m

Software module number flag; must be followed with module. This
argument is only valid for R1 AUDIX Systems.

module

Retrieves errors logged by the software module that you specify.
See the appropriate voice mail system maintenance manual for a
list of modules.

-R

Reporting resource module type flag; must be followed with
reporting-resource-type. This argument is valid only for the
DEFINITY AUDIX system.

reportingresourcetype

Retrieves errors logged by the resource type (module) that you
specify. See the appropriate voice mail system maintenance
manual for a list of resource types.

-T

Resource type flag; must be followed with resource-type. This
argument is valid only for the DEFINITY AUDIX System.

resourcetype

Retrieves errors logged against the resource type that you specify.
See the appropriate voice mail system maintenance manual for a
list of resource types.

-L

Location flag; must be followed with location. This argument is only
valid for the DEFINITY AUDIX system.

location

Retrieves errors logged against resources at the specified location.
The T resource-type argument must also be specified.

-n

Number of records flag; must be followed by nnnn. This argument
is only valid for the DEFINITY AUDIX System.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
geterror

12-32

nnnn

Retrieves the number (nnnn) of records that you specify. If this flag
is not specified, all records that meet the specification criteria are
returned.

-D

Device number flag; must be followed by device. This argument is
valid only for R1 AUDIX Systems. (This flag was n in previous ADAP
versions.)

device

Retrieves errors logged against the device number that you
specify. See the appropriate voice mail system maintenance
manual for a list of devices.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the DEFINITY AUDIX or
R1 AUDIX software. The default is D-r3.2.

-x

Enhanced error logging flag. Enhanced error logging is off by
default. This argument is valid only for R1 AUDIX Systems.

y/n

Retrieves errors in enhanced error display mode if on (y).

-p

Number of pages flag; must be followed by nn. If this flag is
omitted, all pages up to the current time are retrieved. This
argument is valid only for AUDIX Systems.

nn

Retrieves the number (nn) of error pages that you specify.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

Errors
If no errors match the specified search, no output is written.

! CAUTION:
The following caution applies only to AUDIX Systems: If operators on the
local maintenance terminal (LMT) and the local administration terminal
(LAT) concurrently access the same screen information, output on either
terminal could prematurely terminate or reflect other undesirable changes.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
geterror

12-33

Output Format
Output for the geterror command when communicating with a DEFINITY AUDIX
System is formatted as follows, with one record per error.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

date recorded

D

8

D-r1.0+

2

time recorded

T

4

D-r1.0+

3

resource type

C

10

D-r1.0+

4

location

C

7

D-r1.0+

5

event type

C

7

D-r1.0+

6

code

N

4

D-r1.0+

7

count

N

2

D-r1.0+

8

auxiliary data 1

N

10

D-r1.0+

9

auxiliary data 2

N

10

D-r1.0+

10

session number

N

3

D-r1.0+

11

reporting resource data, type

C

10

D-r1.0+

12

reporting resource data, instance

C

8

D-r1.0+

13

reporting resource data, source

N

6

D-r1.0+

14

error text

C

50

D-r1.0+

INTUITY
AUDIX
System

Output for the geterror command when communicating with an R1 AUDIX
System is formatted as follows, with one record per error.

FIELD

VOICE MAIL VERSIONS

Field Name

1

date of occurrence

D

8

r1v2+

2

time of occurrence

T

4

r1v2+

3

count

N

4

r1v2+

4

error

N

4

r1v2+

5

class

N

1

r1v2+

6

session/unit

N

4

r1v2+

7

module

N

2

r1v2+

8

device

N

5

r1v2+

9

enhanced error text

C

50

r1v2+

Type

Max.
Width

R1
AUDIX
System

Seq.
No.

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
geterror

12-34

Example
The following command retrieves the DEFINITY AUDIX Display Errors data from
12:25 p.m. on December 14, 1994, to the hour and minute the command was
entered, writes a summary of the transfer statistics to the screen, and writes
output to a file named errors.
geterror -d 121494 -t 1225 -v > errors

RETURN

The following data is written to the file:
19941214,1225,"ER","01B08","IN_LINE",51,1,2,0,92,"ER",
"1",0,"CHRONO LOG FILE RECREATED DURING INIT" NEWLINE
The following command retrieves the R1 AUDIX R1V8 maintenance : error :
display data from 8:05 a.m. on January 26, 1995, to the hour and minute the
command was entered, writes a summary of the transfer statistics to the screen,
and writes output to a file named errors.
geterror -r r1v8 -d 012695 -t 0805 -v > errors

RETURN

The following data is written to the file:
19950126,0805,1,327,2,35,20,28191,""

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getevent

12-35

getevent
Get event data

Syntax
getevent [-d mmddyy [-t hhmm]] [-c code] [-f search string ] [-s session]
[-R reporting-resource-type] [-T resource-type [-L location]]
[-a y/n] [-e y/n] [-E y/n] [-n nnnnn] [-r release] [-v] [-w] [-V]
[ > ofile]

Description
This command retrieves all pages of the following screens for the date, time, and
search information that you specify:
■

DEFINITY AUDIX Display Events

ADAP updates the specification fields of the DEFINITY AUDIX Display Events
screen while retrieving the data. The system retains the values you supply after
the retrieval is completed.
If you omit the options and their qualifiers (for example; session, Reportingresource-type, Resource-type), then all errors from and including the specified
date and time are returned. For complete lists of errors, sessions, reporting
resource types, resource types, see the appropriate voice mail system
maintenance manual.
No input is required. All events retrieved are written to standard output.

-d

Date flag; must be followed by mmddyy. The default is to retrieve
data for any date.

mmddyy

Retrieves data starting at the month, day, and year indicated by
mmddyy. For example, if you enter 012295, the data starting on
January 22, 1995, will be retrieved.

-t

Time of the day flag; must be followed by hhmm. The default is to
retrieve data starting at any time for the given date.

hhmm

Retrieves errors from the specified hour and minute to the current
time. For example, if you enter 1512 at 6:00 p.m. (for retrieval on
the same day), the data from 3:12 p.m. to 6:00 p.m. will be
retrieved. Midnight is represented by 0000.

-a

Alarm flag; must be followed by y or n. The default is y.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getevent

12-36

y/n

Retrieves or does not retrieve alarm information. Alarm information
includes the following event types:
ALARM

The event representing the activation of an alarm.

RES_MNT

Alarm resolved by maintenance activity.

RES_RST

Alarm resolved by restart.

RES_REM

Alarm resolved by removal of alarmed resource.

-E

Error information flag; must be followed by y or n. The default is y.

y/n

Retrieves or does not retrieve errors. Errors include the following
event types:
IN_LINE

Error encountered during normal system activity.

MP_FAIL

Maintenance procedure or test failed.

-e

Event class message flag; must be followed by either y or n. The
default is y.

y/n

Retrieves or does not retrieve EVENT class messages.

-c

Error/alarm code flag; must be followed by code.

code

Retrieves events matching the error/alarm code that you specify.
This parameter specifies an error code for error information and an
alarm code for alarm information. See the appropriate voice mail
system maintenance manual for a list of errors.

-f

Search string flag; must be followed by search string .

search
string

Retrieves errors containing the search string you specify. The
maximum string length is 50 characters.

-s

Software session number flag; must be followed by session.

session

Retrieves errors logged by the software session number that you
specify. See the appropriate voice mail system maintenance
manual for a list of sessions.

-R

Reporting resource type flag; must be followed with
reporting-resource- type.

reportingresourcetype

Retrieves errors logged by the resource type that you specify. See
the appropriate voice mail system maintenance manual for a list of
resource types.

-T

Resource type flag; must be followed with resource-type.

resourcetype

Retrieves errors logged against the resource type that you specify.
See the appropriate voice mail system maintenance manual for a
list of resource types.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getevent

12-37

-L

Location flag; must be followed with location.

location

Retrieves errors logged against resources at the specified
location. The T resource-type argument must also be specified.

-n

Number of records flag; must be followed by nnnn.

nnnn

Retrieves the number (nnnn) of records that you specify. If this flag
is not used, all records that meet the specification criteria will be
retrieved.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the DEFINITY AUDIX
software. The default for the DEFINITY AUDIX System is D-r3.2.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

NOTE:
The getevent command requires the craft login for the DEFINITY AUDIX
System.

Errors
If no events exist that fit the specified search, no output is written. If you use this
command with an INTUITY AUDIX or R1 AUDIX System, an error message
appears on the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getevent

12-38

Output Format
Output format for the getevent command is formatted as follows, with one record
for each event.
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

date recorded

D

8

D-r1.0+

2

time recorded

T

4

D-r1.0+

3

resource type

C

10

D-r1.0+

4

location

C

7

D-r1.0+

5

event type

C

7

D-r1.0+

6

code

N

4

D-r1.0+

7

count

N

2

D-r1.0+

8

auxiliary data 1

N

10

D-r1.0+

9

auxiliary data 2

N

10

D-r1.0+

10

session number

N

3

D-r1.0+

11

reporting resource data, type

C

10

D-r1.0+

12

reporting resource data, instance

C

8

D-r1.0+

13

reporting resource data, source

N

6

D-r1.0+

14

error text

C

50

D-r1.0+

INTUITY
AUDIX
System

Example
The following command retrieves the DEFINITY AUDIX Display Events data from
12:25 p.m. on October 14, 1994, to the hour and minute the command was
entered, writes a summary of the transfer statistics to the screen, and writes
output to a file named events.
getevent -d 101494 -t 1225 -v > events

RETURN

The following data is written to the file, with one line for each event:
19941014,1225,"ER","01B08","IN_LINE",51,1,2,0,92,"ER",
"1",0,"CHRONO LOG FILE RECREATED DURING INIT" NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfeat

12-39

getfeat
Get traffic measurement data

Syntax
getfeat -f day [-d mmddyy] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]
or
getfeat -f hour [-d mmddyy] [-t hh] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves data for the date specified for the following screens:
■

INTUITY AUDIX List Measurements Feature Day

■

DEFINITY AUDIX List Measurements Feature Day

■

R1 AUDIX (R1V3 and beyond) traffic : feature : day

This command retrieves data for the date and time specified for these screens:
■

INTUITY AUDIX List Measurements Feature Hour

■

DEFINITY AUDIX List Measurements Feature Hour

■

R1 AUDIX ( R1V3 and beyond) traffic : feature : hour

No input is required. Retrieved data is written to standard output.

-f

Screen version flag; must be followed by either day or hour.

day

Retrieves day version of the screen.

hour

Retrieves hour version of the screen.

-d

Date flag must be followed by mmddyy. Flag is required when used
with the AUDIX System. If this flag is omitted, the most recent date’s
data will be returned.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 012295 without subsequently entering the
n option, only the data for January 22, 1995, will be retrieved.

-t

Time of the day flag; must be followed by hh. is required when used
with the AUDIX System. If this flag is omitted, the first hour (hour 0)
of the specified day or the current hour (if no day is specified) will
be returned.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfeat

12-40

hh

Retrieves data for the hour of the day that you have specified
already by mmddyy. For example, if you enter 15 without
subsequently entering the n option, the data from 3:00 p.m. to 4:00
p.m. will be retrieved.

-n

Number of records flag; must be followed by nn. If you don’t
include this option, only one record (hour or day) will be returned.

nn

Retrieves the number (nn) of hourly or daily records that you
specify. For example, if you want to retrieve hourly data and you
enter 15 for hh and then enter 5 for nn, the data for the hours
between 3:00 p.m. and 8:00 p.m. (the data beginning at 3:00 and
continuing through the next five hours) will be retrieved.
The same is true for daily records. If you enter 012295 for mmddyy
and then enter 8 for nn, the data from and including January 22,
1995, and continuing through January 29, 1995, will be retrieved.
For the INTUITY or DEFINITY AUDIX System, you may use the value
all to retrieve all records (hour or day) on or after any specified date
and time.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) software. The
default for the DEFINITY AUDIX System is D-r3.2. The default for the
INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfeat

12-41

Output Format
Output format for the getfeat command with the -f hour option is formatted as
follows, with one record per hour.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

8

r1v3+

D-r1.0+

I-r2.0+

2

r1v3+

D-r1.0+

I-r2.0+

4

r1v3+

D-r1.0+

I-r2.0+

N

2.1

r1v3+

D-r1.0+

I-r2.0+

N

8

r1v3+

D-r1.0+

I-r2.0+

N

8

r1v3+

D-r1.0+

I-r2.0+

VM failed logins, external

N

8

r1v3+

D-r1.0+

I-r2.0+

8

VM failed logins, internal

N

8

r1v3+

D-r1.0+

I-r2.0+

9

VM session usage (seconds)

N

8

r1v3+

D-r1.0+

I-r2.0+

10

VM total messages, sent

N

10

r1v3+

D-r1.0+

I-r2.0+

11

VM total messages, deleted

N

5

r1v3+

D-r1.0+

I-r2.0+

12

VM total messages, current

N

19

r1v3+

D-r1.0+

I-r2.0+

13

VM average storage time

N

8

r1v3+

D-r1.0+

I-r2.0+

14

VM average connect time

N

6

r1v3+

D-r1.0+

I-r2.0+

15

CA completed calls, external

N

8

r1v3+

D-r1.0+

I-r2.0+

16

CA completed calls, internal

N

8

r1v3+

D-r1.0+

I-r2.0+

17

CA abandoned calls, external

N

8

r1v3+

D-r1.0+

I-r2.0+

18

CA abandoned calls, internal

N

8

r1v3+

D-r1.0+

I-r2.0+

19

CA session usage (seconds)

N

8

r1v3+

D-r1.0+

I-r2.0+

20

CA messages, received

N

10

r1v3+

D-r1.0+

I-r2.0+

21

CA messages, deleted

N

5

r1v3+

D-r1.0+

I-r2.0+

22

CA messages, current

N

19

r1v3+

D-r1.0+

I-r2.0+

23

CA average storage time

N

8

r1v3+

D-r1.0+

I-r2.0+

24

CA average connect time

N

6

r1v3+

D-r1.0+

I-r2.0+

25

VM broadcast messages, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

26

VM broadcast messages, current

N

19

r1v5+

D-r1.0+

I-r2.0+

27

VM login announcements, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

28

VM login announcements, current

N

19

r1v5+

D-r1.0+

I-r2.0+

29

VM priority messages, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

30

VM priority messages, current

N

19

r1v5+

D-r1.0+

I-r2.0+

31

VM private messages, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

32

VM private messages, current

N

19

r1v5+

D-r1.0+

I-r2.0+

33

local subscribers

N

6

D-r1.0+

I-r2.0+

34

remote subscribers

N

8

D-r1.0+

I-r2.0+

35

non-administered remote subscribers

N

8

D-r1.0+

I-r2.0+

36

average IMAPI sessions in use

N

5

Seq.
No.

Field Name

Type

1

starting date

D

2

starting hour

N

3

ending time

T

4

average number of ports in use

5

VM successful logins, external

6

VM successful logins, internal

7

Max.
Width

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfeat

12-42
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

37

successful client logins

N

8

I-r5.0+

38

failed client logins

N

8

I-r5.0+

39

client voice mail session usage

N

8

I-r5.0+

40

completed network call answer calls

N

8

I-r5.0+

41

call answer voice components external

N

8

I-r5.0+

42

call answer voice components internal

N

8

I-r5.0+

43

call answer voice components network

N

8

I-r5.0+

44

call answer FAX components external

N

8

I-r5.0+

45

call answer FAX components internal

N

8

I-r5.0+

46

call answer FAX components network

N

8

I-r5.0+

47

abandoned network calls

N

8

I-r5.0+

48

call answer session usage

N

8

I-r5.0+

49

voice mail voice components sent

N

10

I-r5.0+

50

voice mail voice components current

N

19

I-r5.0+

51

voice mail FAX components sent

N

10

I-r5.0+

52

voice mail FAX components current

N

19

I-r5.0+

53

voice mail binary attachments sent

N

10

I-r5.0+

54

voice mail binary attachments current

N

19

I-r5.0+

55

voice mail text components sent

N

10

I-r5.0+

56

voice mail text components current

N

19

I-r5.0+

57

call answer voice components received

N

10

I-r5.0+

58

call answer voice components current

N

19

I-r5.0+

59

call answer FAX components received

N

10

I-r5.0+

60

call answer FAX components current

N

19

I-r5.0+

Output format for the getfeat command with the -f day option is formatted as
follows, with one record per day.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

D

8

r1v3+

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

1

starting date

2

ending time

T

4

r1v3+

D-r1.0+

I-r2.0+

3

max of hourly avg number of ports in use

N

2.1

r1v3+

D-r1.0+

I-r2.0+

4

local subscribers

N

6

r1v3+

D-r1.0+

I-r2.0+

5

VM successful logins, external

N

8

r1v3+

D-r1.0+

I-r2.0+

6

VM successful logins, internal

N

8

r1v3+

D-r1.0+

I-r2.0+

7

VM failed logins, external

N

8

r1v3+

D-r1.0+

I-r2.0+

8

VM failed logins, internal

N

8

r1v3+

D-r1.0+

I-r2.0+

9

VM session usage (seconds)

N

8

r1v3+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfeat

12-43
FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

10

VM total messages, sent

N

10

r1v3+

D-r1.0+

I-r2.0+

11

VM total messages, deleted

N

5

r1v3+

D-r1.0+

I-r2.0+

12

VM total messages, current

N

19

r1v3+

D-r1.0+

I-r2.0+

13

VM average storage time

N

8

r1v3+

D-r1.0+

I-r2.0+

14

VM average connect time

N

6

r1v3+

D-r1.0+

I-r2.0+

15

CA completed calls, external

N

8

r1v3+

D-r1.0+

I-r2.0+

16

CA completed calls, internal

N

8

r1v3+

D-r1.0+

I-r2.0+

17

CA abandoned calls, external

N

8

r1v3+

D-r1.0+

I-r2.0+

18

CA abandoned calls, internal

N

8

r1v3+

D-r1.0+

I-r2.0+

19

CA session usage (seconds)

N

8

r1v3+

D-r1.0+

I-r2.0+

20

CA messages, received

N

10

r1v3+

D-r1.0+

I-r2.0+

21

CA messages, deleted

N

5

r1v3+

D-r1.0+

I-r2.0+

22

CA messages, current

N

19

r1v3+

D-r1.0+

I-r2.0+

23

CA average storage time

N

8

r1v3+

D-r1.0+

I-r2.0+

24

CA average connect time

N

6

r1v3+

D-r1.0+

I-r2.0+

25

remote subscribers

N

8

r1v3+

D-r1.0+

I-r2.0+

26

non-administered remote subscribers

N

8

r1v3+

D-r1.0+

I-r2.0+

27

VM broadcast messages, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

28

VM broadcast messages, current

N

19

r1v5+

D-r1.0+

I-r2.0+

29

VM login announcements, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

30

VM login announcements, current

N

19

r1v5+

D-r1.0+

I-r2.0+

31

VM priority messages, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

32

VM priority messages, current

N

19

r1v5+

D-r1.0+

I-r2.0+

33

VM private messages, sent

N

10

r1v5+

D-r1.0+

I-r2.0+

r1v5+

D-r1.0+

Type

Max.
Width

R1
AUDIX
System

Seq.
No.

34

VM private messages, current

N

19

35

maximum average IMAPI sessions in use

N

5

I-r5.0+

I-r2.0+

36

successful client logins

N

8

I-r5.0+

37

failed client logins

N

8

I-r5.0+

38

client voice mail session usage

N

8

I-r5.0+

39

completed network call answer calls

N

8

I-r5.0+

40

call answer voice components external

N

8

I-r5.0+

41

call answer voice components internal

N

8

I-r5.0+

42

call answer voice components network

N

8

I-r5.0+

43

call answer FAX components external

N

8

I-r5.0+

44

call answer FAX components internal

N

8

I-r5.0+

45

call answer FAX components network

N

8

I-r5.0+

46

abandoned network calls

N

8

I-r5.0+

47

call answer session usage

N

8

I-r5.0+

48

voice mail voice components sent

N

10

I-r5.0+

49

voice mail voice components current

N

19

I-r5.0+

50

voice mail FAX components sent

N

10

I-r5.0+

51

voice mail FAX components current

N

19

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfeat

12-44
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

52

voice mail binary attachments sent

N

10

I-r5.0+

53

voice mail binary attachments current

N

19

I-r5.0+

54

voice mail text components sent

N

10

I-r5.0+

55

voice mail text components current

N

19

I-r5.0+

56

call answer voice components received

N

10

I-r5.0+

57

call answer voice components current

N

19

I-r5.0+

58

call answer FAX components received

N

10

I-r5.0+

59

call answer FAX components current

N

19

I-r5.0+

NOTE:
Field 11, VM total messages deleted , and Field 21, CA messages deleted ,
are reported as numeric zero for AUDIX R1V5 through R1V8 and all
releases of DEFINITY AUDIX

Errors
If either the date or time is invalid when communicating with an R1 AUDIX
System, the retrieval is aborted and no records are written.
For the INTUITY or DEFINITY AUDIX System, if the specified date and time is
before any valid date and time, the retrieval starts at the first date and time with
data. If the specified date and time is following a valid date, an error message is
returned and the retrieval aborts.

Example
The following command retrieves the INTUITY or DEFINITY AUDIX List
Measurements Features Day screen data for December 22, 1994, writes a
summary of the transfer statistics to the screen, and writes output to a file named
daylds.
getfeat -f day -d 122294 -v > daylds

RETURN

The following data is written to the file:
19941222,2359,12.8,1382,340,2333,272,60,265883,604,0,
877,1711,99,1750,1603,467,268,142055,2521,0,2485,1590,
42,6436,66,0,0,0,0,2,6,5,10 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfrag

12-45

getfrag
Get fragment data

Syntax
getfrag -f fragment id [-a announcement set] [-r release] [-v] [-w]
[-V] [ > ofile]

Description
This command retrieves the fragment and announcement set you specify for
the following screens:
■

INTUITY AUDIX Display Fragment

■

DEFINITY AUDIX Display Fragment

No input is required. Retrieved data is written to standard output.

-f

Fragment identifier flag; must be followed by
fragment id .

fragment id

Retrieves data for the specified fragment identifier.
The fragment identifier’s syntax is nnnn where nnnn
is the fragment number.

-a

Announcement set flag; must be followed by
announcement set.

announcement set

Retrieves data for the fragment id of the specified
announcement set. The default is the administered
announcement set. See the INTUITY AUDIX R3.3
Administration and Feature Operations
585-310-552 for the procedure to find a list of valid
announcement sets.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the
INTUITY or DEFINITY AUDIX software. The default
for the DEFINITY AUDIX System is D-r3.2. The
default for the INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of
the transfer.
Pressing -v while the command is executing sends
the updated transfer status to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getfrag

12-46

-w

Writes a one-line summary of the exit status of this
command into the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol > . If no output file is
specified, data is written to the screen.

Errors
If you use this command with the R1 AUDIX System, an error message appears
on the screen.

Output Format
Output for the getfrag command is as follows.

FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

14

D-r1.0+

I-r2.0+

C

5

D-r1.0+

I-r2.0+

D

8

D-r1.0+

I-r2.0+

T

4

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

Type

Max.
Width

1

announcement set

C

2

fragment id

3

voice timestamp date

4

voice timestamp time

R1
AUDIX
System

Example
The following command retrieves the INTUITY or DEFINITY AUDIX Display
Fragment screen data for fragment 25 for the “standard” announcement set and
writes output to a file named frags.
getfrag -f f25 -a standard >frags

RETURN

The following data is written to the file:
"standard","f25",19941121,0537

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlimit

12-47

getlimit
Get system parameter limits

Syntax
getlimit [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves the following screens:
■

INTUITY AUDIX Display System-Parameters Limits

■

DEFINITY AUDIX Display System-Parameters Limits

■

R1 AUDIX system : limits

No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX software. The default for the
DEFINITY AUDIX System is D-r3.2. The default for the INTUITY AUDIX
System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

Errors
No errors are associated with this command.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlimit

12-48

Output Format
Output for the getlimit command is as follows.
FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

1

recommended names FS size

N

9

r1v2+

D-r1.0+

I-r2.0+

2

min message length

N

2

r1v2+

D-r1.0+

I-r2.0+

3

max local subscribers

N

6

r1v2+

D-r1.0+

I-r2.0+

4

total list entries

N

6

r1v2+

D-r1.0+

I-r2.0+

5

lists per subscriber

N

3

r1v2+

D-r1.0+

I-r2.0+

6

recipients per list

N

3

r1v2+

D-r1.0+

I-r2.0+

7

max error log entries

N

5

r1v2+

D-r1.0+

I-r2.0+

8

total messages in all mailboxes

N

6

r1v2+

D-r1.0+

I-r2.0+

9

total messages awaiting delivery

N

6

r1v2+

D-r1.0+

I-r2.0+

10

max message length

N

4

r1v2+

D-r1.0+

I-r2.0+

11

recommended system data FS size

N

9

r1v2+

D-r1.0+

I-r2.0+

12

recommended voice data FS size

N

9

r1v2+

D-r1.0+

I-r2.0+

13

recommended system status FS size

N

9

r1v3+

D-r1.0+

I-r2.0+

14

max admin remote subscribers

N

8

r1v3+

D-r1.0+

I-r2.0+

15

max admin log entries

N

5

r1v3+

D-r1.0+

I-r2.0+

16

max activity log entries

N

5

r1v5+

Type

Max.
Width

R1
AUDIX
System

Seq.
No.

NOTE:
Field 4, total list entries, is reported as numeric zero for AUDIX R1V2 .

Example
The following command retrieves the INTUITY or DEFINITY AUDIX Display
System-Parameters Limits screen data, writes a summary of the transfer statistics
to the screen, and writes output to a file named limits.
getlimit -v > limits

RETURN

The following data is written to the file:
0,10,1000,50000,100,250,1,50000,5000,1200,0,0,0,1000,
1000 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlimit

12-49

The following command retrieves the AUDIX R1V8 system : limits screen data,
writes a summary of the transfer statistics to the screen, and writes output to a file
named limits.
getlimit -v -r r1v8 > limits

RETURN

The following data is written to the file:
4500,3,1000,20000,100,200,10000,2000,200,1200,488,128,
383,14000,1000,1000 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlist

12-50

getlist
Syntax
getlist [-r release] [-v] [-w] [-V] [ >ofile]

Description
This command retrieves all pages of the following screens:
■

INTUITY AUDIX List Subscribers

■

DEFINITY AUDIX List Subscribers

■

R1 AUDIX list : subscriber

No input is required. Retrieved data is written to standard output.
NOTE:
The output of this command can be used as input for the local subscriber
modification commands described in Chapter 13, "Command Line
Database Modification Commands", such as changmis.

-r

Release flag: must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1AUDIX software. The default for the
DEFINITY AUDIX System is D-r3.2. The default for the INTUITY
AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing -v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

>ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlist

12-51

Errors
No errors are associated with this command.

! CAUTION:
The following caution applies only to the AUDIX System: If operators on the
local maintenance terminal (LMT) and the local administration terminal
(LAT) concurrently access the same screen information, output on either
terminal could prematurely terminate or reflect other undesirable changes.

Output Format
Output for the getlist command is formatted as follows, with one record for each
subscriber.

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

subscriber name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

class of service

C

8

r1v2+

D-r1.0+

I-r2.0+

4

miscellaneous 1

C

11

r1v2+

D-r1.0+

I-r2.0+

5

miscellaneous 2

C

11

I-r5.0+

6

miscellaneous 3

C

11

I-r5.0+

7

miscellaneous 4

C

11

I-r5.0+

Example
The following command retrieves the List Subscribers data for all INTUITY or
DEFINITY AUDIX System subscribers, writes a summary of the transfer statistics
to the screen, and writes output to a file named subs. The output is the same for
the R1 AUDIX System, but the release must be specified on the command line.
getlist -v > subs

RETURN

The following data is written to the file, one line for each subscriber.
"Doe, John","1234","def","1111"

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-52

getload

12

Get load measurement lists

12

Syntax

getload -f day [-d mmddyy] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]
or
getload -f hour [-d mmddyy] [-t hh] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves the following screens for the date you specify in the
command options:
■

INTUITY AUDIX List Measurements Load Day

■

DEFINITY AUDIX List Measurements Load Day

■

R1 AUDIX traffic : load : day

This command retrieves the following screens for the date and time you specify
in the command options:
■

INTUITY AUDIX List Measurements Load Hour

■

DEFINITY AUDIX List Measurements Load Hour

■

R1 AUDIX traffic : load : hour

No input is required. Retrieved data is written to standard output.

-f

Screen flag; must be followed by either day or hour.

day

Retrieves day version of the screen data.

hour

Retrieves hour version of the screen data.

-d

Date flag; must be followed by mmddyy. This flag is required when
used with the R1 AUDIX System. If this flag is omitted, the most
recent date’s data will be returned.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 072294 without subsequently entering the
-n option, only the data for July 22, 1994, will be retrieved.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-53

-t

Time of the day; flag must be followed by hh. This flag is required
when used with the R1 AUDIX System. If this flag is omitted, the
first hour (hour 0) of the specified day or the current hour (if no day
is specified) will be returned.

hh

Retrieves data for the hour (hh) of the day (mmddyy) that you have
specified already. For example, if you enter 15 without
subsequently entering the -n option, only the data from 3:00 p.m.
to 4:00 p.m. will be retrieved.

-n

Number of records flag; must be followed by nn. If you do not
include this flag, only one record (hour or day) will be returned.

nn

Retrieves the number (nn) of hourly or daily records that you
specify. For example, if you want to retrieve hourly data and you
enter 15 for hh and then enter 5 for nn, the data for the hours
between 3:00 p.m. and 8:00 p.m. (the data beginning at 3:00 and
continuing through the next five hours) will be retrieved.
The same is true for daily records. If you enter 082294 for mmddyy
and then enter 8 for nn, the data from and including August 22,
1994, and continuing through August 29, 1994, will be retrieved.
For the INTUITY or DEFINITY AUDIX System, you may use the value
all to retrieve all records (hour or day) on or after any specified
date and time.

-r

Indicates that the argument following is the name of the release.
This argument must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX software. The default for the
DEFINITY AUDIX System is D-r3.2. The default for the INTUITY
AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing -v while the command is executing sends the updated
transfer status to the screen

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-54

Errors
If either the date or time is invalid when communicating with an R1 AUDIX
System, the retrieval aborts and no records are written.
If the specified date and time is before any valid date and time when
communicating with a INTUITY or DEFINITY AUDIX System, the retrieval starts at
the first date and time with data. If the specified date and time is after a valid
date, an error message is returned and the retrieval aborts.

Output Format
Output for the getload command when communicating with an R1 AUDIX or an
INTUITY AUDIX System using the -f day option is formatted as follows, with one
record for each day.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

D

8

r1v2+

I-r2.0+

ending time

T

4

r1v2+

I-r2.0+

3

subscriber threshold list exceptions

N

5

r1v2+

I-r2.0+

4

subscriber threshold list space exceptions

N

5

r1v2+

I-r2.0+

5

subscriber lower msg space exceptions

N

5

r1v2+

I-r2.0+

6

subscriber upper msg space exceptions

N

5

r1v2+

I-r2.0+

7

total subscribers over threshold

N

19

r1v2+

I-r2.0+

8

deliveries rescheduled

N

8

r1v2+

I-r2.0+

9

maximum simultaneous ports

N

3

r1v2+

I-r2.0+

10

maximum voice text used

N

9

r1v2+

I-r2.0+

11

minimum voice text free space

N

9

r1v2+

I-r2.0+

12

port 1 usage in seconds

N

6

r1v2+

I-r2.0+

13

port 2 usage in seconds

N

6

r1v2+

I-r2.0+

14

port 3 usage in seconds

N

6

r1v2+

I-r2.0+

15

port 4 usage in seconds

N

6

r1v2+

I-r2.0+

16

port 5 usage in seconds

N

6

r1v2+

I-r2.0+

17

port 6 usage in seconds

N

6

r1v2+

I-r2.0+

18

port 7 usage in seconds

N

6

r1v2+

I-r2.0+

19

port 8 usage in seconds

N

6

r1v2+

I-r2.0+

20

port 9 usage in seconds

N

6

r1v2+

I-r2.0+

21

port 10 usage in seconds

N

6

r1v2+

I-r2.0+

22

port 11 usage in seconds

N

6

r1v2+

I-r2.0+

23

port 12 usage in seconds

N

6

r1v2+

I-r2.0+

24

port 13 usage in seconds

N

6

r1v2+

I-r2.0+

25

port 14 usage in seconds

N

6

r1v2+

I-r2.0+

26

port 15 usage in seconds

N

6

r1v2+

I-r2.0+

Seq.
No.

Field Name

1

starting date

2

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-55
FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Type

Max.
Width

R1
AUDIX
System

port 16 usage in seconds

N

6

r1v2+

I-r2.0+

port 17 usage in seconds

N

6

r1v2+

I-r2.0+

29

port 18 usage in seconds

N

6

r1v2+

I-r2.0+

30

port 19 usage in seconds

N

6

r1v2+

I-r2.0+

31

port 20 usage in seconds

N

6

r1v2+

I-r2.0+

32

port 21 usage in seconds

N

6

r1v2+

I-r2.0+

33

port 22 usage in seconds

N

6

r1v2+

I-r2.0+

34

port 23 usage in seconds

N

6

r1v2+

I-r2.0+

35

port 24 usage in seconds

N

6

r1v2+

I-r2.0+

36

port 25 usage in seconds

N

6

r1v2+

I-r2.0+

37

port 26 usage in seconds

N

6

r1v2+

I-r2.0+

38

port 27 usage in seconds

N

6

r1v2+

I-r2.0+

39

port 28 usage in seconds

N

6

r1v2+

I-r2.0+

40

port 29 usage in seconds

N

6

r1v2+

I-r2.0+

41

port 30 usage in seconds

N

6

r1v2+

I-r2.0+

42

port 31 usage in seconds

N

6

r1v2+

I-r2.0+

43

port 32 usage in seconds

N

6

r1v2+

I-r2.0+

44

port 1 peg count

N

6

r1v2+

I-r2.0+

45

port 2 peg count

N

6

r1v2+

I-r2.0+

46

port 3 peg count

N

6

r1v2+

I-r2.0+

47

port 4 peg count

N

6

r1v2+

I-r2.0+

48

port 5 peg count

N

6

r1v2+

I-r2.0+

49

port 6 peg count

N

6

r1v2+

I-r2.0+

50

port 7 peg count

N

6

r1v2+

I-r2.0+

51

port 8 peg count

N

6

r1v2+

I-r2.0+

52

port 9 peg count

N

6

r1v2+

I-r2.0+

53

port 10 peg count

N

6

r1v2+

I-r2.0+

54

port 11 peg count

N

6

r1v2+

I-r2.0+

55

port 12 peg count

N

6

r1v2+

I-r2.0+

56

port 13 peg count

N

6

r1v2+

I-r2.0+

57

port 14 peg count

N

6

r1v2+

I-r2.0+

58

port 15 peg count

N

6

r1v2+

I-r2.0+

59

port 16 peg count

N

6

r1v2+

I-r2.0+

60

port 17 peg count

N

6

r1v2+

I-r2.0+

61

port 18 peg count

N

6

r1v2+

I-r2.0+

62

port 19 peg count

N

6

r1v2+

I-r2.0+

63

port 20 peg count

N

6

r1v2+

I-r2.0+

64

port 21 peg count

N

6

r1v2+

I-r2.0+

65

port 22 peg count

N

6

r1v2+

I-r2.0+

66

port 23 peg count

N

6

r1v2+

I-r2.0+

67

port 24 peg count

N

6

r1v2+

I-r2.0+

68

port 25 peg count

N

6

r1v2+

I-r2.0+

Seq.
No.

Field Name

27
28

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-56
FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Type

Max.
Width

R1
AUDIX
System

port 26 peg count

N

6

r1v2+

I-r2.0+

port 27 peg count

N

6

r1v2+

I-r2.0+

71

port 28 peg count

N

6

r1v2+

I-r2.0+

72

port 29 peg count

N

6

r1v2+

I-r2.0+

73

port 30 peg count

N

6

r1v2+

I-r2.0+

74

port 31 peg count

N

6

r1v2+

I-r2.0+

75

port 32 peg count

N

6

r1v2+

I-r2.0+

76

port 33 usage in seconds

N

6

I-r2.0+

77

port 34 usage in seconds

N

6

I-r2.0+

78

port 35 usage in seconds

N

6

I-r2.0+

79

port 36 usage in seconds

N

6

I-r2.0+

80

port 37 usage in seconds

N

6

I-r2.0+

81

port 38 usage in seconds

N

6

I-r2.0+

82

port 39 usage in seconds

N

6

I-r2.0+

83

port 40 usage in seconds

N

6

I-r2.0+

84

port 41 usage in seconds

N

6

I-r2.0+

85

port 42 usage in seconds

N

6

I-r2.0+

86

port 43 usage in seconds

N

6

I-r2.0+

87

port 44 usage in seconds

N

6

I-r2.0+

88

port 45 usage in seconds

N

6

I-r2.0+

89

port 46 usage in seconds

N

6

I-r2.0+

90

port 47 usage in seconds

N

6

I-r2.0+

91

port 48 usage in seconds

N

6

I-r2.0+

92

port 49 usage in seconds

N

6

I-r2.0+

93

port 50 usage in seconds

N

6

I-r2.0+

94

port 51 usage in seconds

N

6

I-r2.0+

95

port 52 usage in seconds

N

6

I-r2.0+

96

port 53 usage in seconds

N

6

I-r2.0+

97

port 54 usage in seconds

N

6

I-r2.0+

98

port 55 usage in seconds

N

6

I-r2.0+

99

port 56 usage in seconds

N

6

I-r2.0+

100

port 57 usage in seconds

N

6

I-r2.0+

101

port 58 usage in seconds

N

6

I-r2.0+

102

port 59 usage in seconds

N

6

I-r2.0+

103

port 60 usage in seconds

N

6

I-r2.0+

104

port 61 usage in seconds

N

6

I-r2.0+

105

port 62 usage in seconds

N

6

I-r2.0+

106

port 63 usage in seconds

N

6

I-r2.0+

107

port 64 usage in seconds

N

6

I-r2.0+

108

port 33 peg count

N

6

I-r2.0+

109

port 34 peg count

N

6

I-r2.0+

110

port 35 peg count

N

6

I-r2.0+

Seq.
No.

Field Name

69
70

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-57
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

111

port 36 peg count

N

6

I-r2.0+

112

port 37 peg count

N

6

I-r2.0+

113

port 38 peg count

N

6

I-r2.0+

114

port 39 peg count

N

6

I-r2.0+

115

port 40 peg count

N

6

I-r2.0+

116

port 41 peg count

N

6

I-r2.0+

117

port 42 peg count

N

6

I-r2.0+

118

port 43 peg count

N

6

I-r2.0+

119

port 44 peg count

N

6

I-r2.0+

120

port 45 peg count

N

6

I-r2.0+

121

port 46 peg count

N

6

I-r2.0+

122

port 47 peg count

N

6

I-r2.0+

123

port 48 peg count

N

6

I-r2.0+

124

port 49 peg count

N

6

I-r2.0+

125

port 50 peg count

N

6

I-r2.0+

126

port 51 peg count

N

6

I-r2.0+

127

port 52 peg count

N

6

I-r2.0+

128

port 53 peg count

N

6

I-r2.0+

129

port 54 peg count

N

6

I-r2.0+

130

port 55 peg count

N

6

I-r2.0+

131

port 56 peg count

N

6

I-r2.0+

132

port 57 peg count

N

6

I-r2.0+

133

port 58 peg count

N

6

I-r2.0+

134

port 59 peg count

N

6

I-r2.0+

135

port 60 peg count

N

6

I-r2.0+

136

port 61 peg count

N

6

I-r2.0+

137

port 62 peg count

N

6

I-r2.0+

138

port 63 peg count

N

6

I-r2.0+

139

port 64 peg count

N

6

I-r2.0+

140

total storage used (hours)

N

12.1

I-r4.0+

141

total storage free (hours)

N

12.1

I-r4.0+

142

message storage used (hours)

N

12.1

I-r4.0+

143

voiced name storage used (hours)

N

12.1

I-r4.0+

144

percent remote

N

2

I-r4.0+

145

announcement storage used (hours)

N

12.1

I-r4.0+

146

maximum simultaneous IMAPI sessions

N

3

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-58

Output for the getload command when communicating with a DEFINITY AUDIX
System using the -f day option is formatted as follows, with one record for each
day.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

starting date

D

8

D-r1.0+

2

ending time

T

4

D-r1.0+

3

subscriber threshold list exceptions

N

5

D-r1.0+

4

subscriber threshold space exceptions

N

5

D-r1.0+

5

subscriber lower msg space exceptions

N

5

D-r1.0+

6

subscriber upper msg space exceptions

N

5

D-r1.0+

7

total subscribers over threshold

N

6

D-r1.0+

8

deliveries rescheduled

N

8

D-r1.0+

maximum simultaneous ports

N

3

D-r1.0+

10

9

maximum voice text/system storage used

N

9

D-r1.0+

11

minimum voice text/system storage free space

N

9

D-r1.0+

12

port 1 usage in seconds

N

6

D-r1.0+

13

port 2 usage in seconds

N

6

D-r1.0+

14

port 3 usage in seconds

N

6

D-r1.0+

15

port 4 usage in seconds

N

6

D-r1.0+

16

port 5 usage in seconds

N

6

D-r1.0+

17

port 6 usage in seconds

N

6

D-r1.0+

18

port 7 usage in seconds

N

6

D-r1.0+

19

port 8 usage in seconds

N

6

D-r1.0+

20

port 9 usage in seconds

N

6

D-r1.0+

21

port 10 usage in seconds

N

6

D-r1.0+

22

port 11 usage in seconds

N

6

D-r1.0+

23

port 12 usage in seconds

N

6

D-r1.0+

24

port 13 usage in seconds

N

6

D-r1.0+

25

port 14 usage in seconds

N

6

D-r1.0+

26

port 15 usage in seconds

N

6

D-r1.0+

27

port 16 usage in seconds

N

6

D-r1.0+

28

port 17 usage in seconds

N

6

D-r1.0+

29

port 18 usage in seconds

N

6

D-r1.0+

30

port 19 usage in seconds

N

6

D-r1.0+

31

port 20 usage in seconds

N

6

D-r1.0+

32

port 21 usage in seconds

N

6

D-r1.0+

33

port 22 usage in seconds

N

6

D-r1.0+

34

port 23 usage in seconds

N

6

D-r1.0+

35

port 24 usage in seconds

N

6

D-r1.0+

36

port 25 usage in seconds

N

6

D-r1.0+

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-59
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

37

port 26 usage in seconds

N

6

D-r1.0+

38

port 27 usage in seconds

N

6

D-r1.0+

39

port 28 usage in seconds

N

6

D-r1.0+

40

port 29 usage in seconds

N

6

D-r1.0+

41

port 30 usage in seconds

N

6

D-r1.0+

42

port 31 usage in seconds

N

6

D-r1.0+

43

port 32 usage in seconds

N

6

D-r1.0+

44

port 1 peg count

N

6

D-r1.0+

45

port 2 peg count

N

6

D-r1.0+

46

port 3 peg count

N

6

D-r1.0+

47

port 4 peg count

N

6

D-r1.0+

48

port 5 peg count

N

6

D-r1.0+

49

port 6 peg count

N

6

D-r1.0+

50

port 7 peg count

N

6

D-r1.0+

51

port 8 peg count

N

6

D-r1.0+

52

port 9 peg count

N

6

D-r1.0+

53

port 10 peg count

N

6

D-r1.0+

54

port 11 peg count

N

6

D-r1.0+

55

port 12 peg count

N

6

D-r1.0+

56

port 13 peg count

N

6

D-r1.0+

57

port 14 peg count

N

6

D-r1.0+

58

port 15 peg count

N

6

D-r1.0+

59

port 16 peg count

N

6

D-r1.0+

60

port 17 peg count

N

6

D-r1.0+

61

port 18 peg count

N

6

D-r1.0+

62

port 19 peg count

N

6

D-r1.0+

63

port 20 peg count

N

6

D-r1.0+

64

port 21 peg count

N

6

D-r1.0+

65

port 22 peg count

N

6

D-r1.0+

66

port 23 peg count

N

6

D-r1.0+

67

port 24 peg count

N

6

D-r1.0+

68

port 25 peg count

N

6

D-r1.0+

69

port 26 peg count

N

6

D-r1.0+

70

port 27 peg count

N

6

D-r1.0+

71

port 28 peg count

N

6

D-r1.0+

72

port 29 peg count

N

6

D-r1.0+

73

port 30 peg count

N

6

D-r1.0+

74

port 31 peg count

N

6

D-r1.0+

75

port 32 peg count

N

6

D-r1.0+

76

total storage used (hours)

N

12.1

D-r3.2+

77

total storage free (hours)

N

12.1

D-r3.2+

78

message storage used (hours)

N

12.1

D-r3.2+

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-60
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

79

voiced name storage used (hours)

N

12.1

D-r3.2+

80

percent remote

N

2

D-r3.2+

81

announcement storage used (hours)

N

12.1

D-r3.2+

INTUITY
AUDIX
System

Output for the getload command when communicating with an R1 AUDIX
System or an INTUITY AUDIX System using the -f hour option is formatted as
follows, with one record for each hour.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

D

8

r1v2+

I-r2.0+

starting hour

N

2

r1v2+

I-r2.0+

ending time

T

4

r1v2+

I-r2.0+

4

subscriber threshold list exceptions

N

5

r1v2+

I-r2.0+

5

subscriber threshold list space exceptions

N

5

r1v2+

I-r2.0+

6

subscriber lower msg space exceptions

N

5

r1v2+

I-r2.0+

7

subscriber upper msg space exceptions

N

5

r1v2+

I-r2.0+

8

total subscribers over threshold

N

19

r1v2+

I-r2.0+

9

deliveries rescheduled

N

8

r1v2+

I-r2.0+

10

maximum simultaneous ports

N

3

r1v2+

I-r2.0+

11

maximum voice text used

N

9

r1v2+

I-r2.0+

12

minimum voice text free space

N

9

r1v2+

I-r2.0+

13

port 1 usage in seconds

N

6

r1v2+

I-r2.0+

14

port 2 usage in seconds

N

6

r1v2+

I-r2.0+

15

port 3 usage in seconds

N

6

r1v2+

I-r2.0+

16

port 4 usage in seconds

N

6

r1v2+

I-r2.0+

17

port 5 usage in seconds

N

6

r1v2+

I-r2.0+

18

port 6 usage in seconds

N

6

r1v2+

I-r2.0+

19

port 7 usage in seconds

N

6

r1v2+

I-r2.0+

20

port 8 usage in seconds

N

6

r1v2+

I-r2.0+

21

port 9 usage in seconds

N

6

r1v2+

I-r2.0+

22

port 10 usage in seconds

N

6

r1v2+

I-r2.0+

23

port 11 usage in seconds

N

6

r1v2+

I-r2.0+

24

port 12 usage in seconds

N

6

r1v2+

I-r2.0+

25

port 13 usage in seconds

N

6

r1v2+

I-r2.0+

26

port 14 usage in seconds

N

6

r1v2+

I-r2.0+

27

port 15 usage in seconds

N

6

r1v2+

I-r2.0+

28

port 16 usage in seconds

N

6

r1v2+

I-r2.0+

29

port 17 usage in seconds

N

6

r1v2+

I-r2.0+

Seq.
No.

Field Name

1

starting date

2
3

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-61
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

30

port 18 usage in seconds

N

6

r1v2+

I-r2.0+

31

port 19 usage in seconds

N

6

r1v2+

I-r2.0+

32

port 20 usage in seconds

N

6

r1v2+

I-r2.0+

33

port 21 usage in seconds

N

6

r1v2+

I-r2.0+

34

port 22 usage in seconds

N

6

r1v2+

I-r2.0+

35

port 23 usage in seconds

N

6

r1v2+

I-r2.0+

36

port 24 usage in seconds

N

6

r1v2+

I-r2.0+

37

port 25 usage in seconds

N

6

r1v2+

I-r2.0+

38

port 26 usage in seconds

N

6

r1v2+

I-r2.0+

39

port 27 usage in seconds

N

6

r1v2+

I-r2.0+

40

port 28 usage in seconds

N

6

r1v2+

I-r2.0+

41

port 29 usage in seconds

N

6

r1v2+

I-r2.0+

42

port 30 usage in seconds

N

6

r1v2+

I-r2.0+

43

port 31 usage in seconds

N

6

r1v2+

I-r2.0+

44

port 32 usage in seconds

N

6

r1v2+

I-r2.0+

45

port 1 peg count

N

6

r1v2+

I-r2.0+

46

port 2 peg count

N

6

r1v2+

I-r2.0+

47

port 3 peg count

N

6

r1v2+

I-r2.0+

48

port 4 peg count

N

6

r1v2+

I-r2.0+

49

port 5 peg count

N

6

r1v2+

I-r2.0+

50

port 6 peg count

N

6

r1v2+

I-r2.0+

51

port 7 peg count

N

6

r1v2+

I-r2.0+

52

port 8 peg count

N

6

r1v2+

I-r2.0+

53

port 9 peg count

N

6

r1v2+

I-r2.0+

54

port 10 peg count

N

6

r1v2+

I-r2.0+

55

port 11 peg count

N

6

r1v2+

I-r2.0+

56

port 12 peg count

N

6

r1v2+

I-r2.0+

57

port 13 peg count

N

6

r1v2+

I-r2.0+

58

port 14 peg count

N

6

r1v2+

I-r2.0+

59

port 15 peg count

N

6

r1v2+

I-r2.0+

60

port 16 peg count

N

6

r1v2+

I-r2.0+

61

port 17 peg count

N

6

r1v2+

I-r2.0+

62

port 18 peg count

N

6

r1v2+

I-r2.0+

63

port 19 peg count

N

6

r1v2+

I-r2.0+

64

port 20 peg count

N

6

r1v2+

I-r2.0+

65

port 21 peg count

N

6

r1v2+

I-r2.0+

66

port 22 peg count

N

6

r1v2+

I-r2.0+

67

port 23 peg count

N

6

r1v2+

I-r2.0+

68

port 24 peg count

N

6

r1v2+

I-r2.0+

69

port 25 peg count

N

6

r1v2+

I-r2.0+

70

port 26 peg count

N

6

r1v2+

I-r2.0+

71

port 27 peg count

N

6

r1v2+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-62
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

72

port 28 peg count

N

6

r1v2+

I-r2.0+

73

port 29 peg count

N

6

r1v2+

I-r2.0+

74

port 30 peg count

N

6

r1v2+

I-r2.0+

75

port 31 peg count

N

6

r1v2+

I-r2.0+

76

port 32 peg count

N

6

r1v2+

I-r2.0+

77

port 33 usage in seconds

N

6

I-r2.0+

78

port 34 usage in seconds

N

6

I-r2.0+

79

port 35 usage in seconds

N

6

I-r2.0+

80

port 36 usage in seconds

N

6

I-r2.0+

81

port 37 usage in seconds

N

6

I-r2.0+

82

port 38 usage in seconds

N

6

I-r2.0+

83

port 39 usage in seconds

N

6

I-r2.0+

84

port 40 usage in seconds

N

6

I-r2.0+

85

port 41 usage in seconds

N

6

I-r2.0+

86

port 42 usage in seconds

N

6

I-r2.0+

87

port 43 usage in seconds

N

6

I-r2.0+

88

port 44 usage in seconds

N

6

I-r2.0+

89

port 45 usage in seconds

N

6

I-r2.0+

90

port 46 usage in seconds

N

6

I-r2.0+

91

port 47 usage in seconds

N

6

I-r2.0+

92

port 48 usage in seconds

N

6

I-r2.0+

93

port 49 usage in seconds

N

6

I-r2.0+

94

port 50 usage in seconds

N

6

I-r2.0+

95

port 51 usage in seconds

N

6

I-r2.0+

96

port 52 usage in seconds

N

6

I-r2.0+

97

port 53 usage in seconds

N

6

I-r2.0+

98

port 54 usage in seconds

N

6

I-r2.0+

99

port 55 usage in seconds

N

6

I-r2.0+

100

port 56 usage in seconds

N

6

I-r2.0+

101

port 57 usage in seconds

N

6

I-r2.0+

102

port 58 usage in seconds

N

6

I-r2.0+

103

port 59 usage in seconds

N

6

I-r2.0+

104

port 60 usage in seconds

N

6

I-r2.0+

105

port 61 usage in seconds

N

6

I-r2.0+

106

port 62 usage in seconds

N

6

I-r2.0+

107

port 63 usage in seconds

N

6

I-r2.0+

108

port 64 usage in seconds

N

6

I-r2.0+

109

port 33 peg count

N

6

I-r2.0+

110

port 34 peg count

N

6

I-r2.0+

111

port 35 peg count

N

6

I-r2.0+

112

port 36 peg count

N

6

I-r2.0+

113

port 37 peg count

N

6

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-63
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

114

port 38 peg count

N

6

I-r2.0+

115

port 39 peg count

N

6

I-r2.0+

116

port 40 peg count

N

6

I-r2.0+

117

port 41 peg count

N

6

I-r2.0+

118

port 42 peg count

N

6

I-r2.0+

119

port 43 peg count

N

6

I-r2.0+

120

port 44 peg count

N

6

I-r2.0+

121

port 45 peg count

N

6

I-r2.0+

122

port 46 peg count

N

6

I-r2.0+

123

port 47 peg count

N

6

I-r2.0+

124

port 48 peg count

N

6

I-r2.0+

125

port 49 peg count

N

6

I-r2.0+

126

port 50 peg count

N

6

I-r2.0+

127

port 51 peg count

N

6

I-r2.0+

128

port 52 peg count

N

6

I-r2.0+

129

port 53 peg count

N

6

I-r2.0+

130

port 54 peg count

N

6

I-r2.0+

131

port 55 peg count

N

6

I-r2.0+

132

port 56 peg count

N

6

I-r2.0+

133

port 57 peg count

N

6

I-r2.0+

134

port 58 peg count

N

6

I-r2.0+

135

port 59 peg count

N

6

I-r2.0+

136

port 60 peg count

N

6

I-r2.0+

137

port 61 peg count

N

6

I-r2.0+

138

port 62 peg count

N

6

I-r2.0+

139

port 63 peg count

N

6

I-r2.0+

140

port 64 peg count

N

6

I-r2.0+

141

total storage used (hours)

N

12.1

I-r4.0+

142

total storage free (hours)

N

12.1

I-r4.0+

143

message storage used (hours)

N

12.1

I-r4.0+

144

voiced name storage used (hours)

N

12.1

I-r4.0+

145

percent remote

N

2

I-r4.0+

146

announcement storage used (hours)

N

12.1

I-r4.0+

147

maximum simultaneous IMAPI sessions

N

3

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-64

Output of the getload command when communicating with a DEFINITY AUDIX
System using the -f hour option is formatted as follows, with one record for each
hour.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

starting date

D

8

D-r1.0+

2

starting hour

N

2

D-r1.0+

3

ending time

T

4

D-r1.0+

4

subscriber threshold list exceptions

N

5

D-r1.0+

5

subscriber threshold list space exceptions

N

5

D-r1.0+

6

subscriber lower msg space exceptions

N

5

D-r1.0+

7

subscriber upper msg space exceptions

N

5

D-r1.0+

8

total subscribers over threshold

N

6

D-r1.0+

9

deliveries rescheduled

N

8

D-r1.0+

10

maximum simultaneous ports

N

3

D-r1.0+

11

maximum voice text/system storage used

N

9

D-r1.0+

12

minimum voice text/system storage free space

N

9

D-r1.0+

13

port 1 usage in seconds

N

6

D-r1.0+

14

port 2 usage in seconds

N

6

D-r1.0+

15

port 3 usage in seconds

N

6

D-r1.0+

16

port 4 usage in seconds

N

6

D-r1.0+

17

port 5 usage in seconds

N

6

D-r1.0+

18

port 6 usage in seconds

N

6

D-r1.0+

19

port 7 usage in seconds

N

6

D-r1.0+

20

port 8 usage in seconds

N

6

D-r1.0+

21

port 9 usage in seconds

N

6

D-r1.0+

22

port 10 usage in seconds

N

6

D-r1.0+

23

port 11 usage in seconds

N

6

D-r1.0+

24

port 12 usage in seconds

N

6

D-r1.0+

25

port 13 usage in seconds

N

6

D-r1.0+

26

port 14 usage in seconds

N

6

D-r1.0+

27

port 15 usage in seconds

N

6

D-r1.0+

28

port 16 usage in seconds

N

6

D-r1.0+

29

port 17 usage in seconds

N

6

D-r1.0+

30

port 18 usage in seconds

N

6

D-r1.0+

31

port 19 usage in seconds

N

6

D-r1.0+

32

port 20 usage in seconds

N

6

D-r1.0+

33

port 21 usage in seconds

N

6

D-r1.0+

34

port 22 usage in seconds

N

6

D-r1.0+

35

port 23 usage in seconds

N

6

D-r1.0+

36

port 24 usage in seconds

N

6

D-r1.0+

37

port 25 usage in seconds

N

6

D-r1.0+

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-65
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

38

port 26 usage in seconds

N

6

D-r1.0+

39

port 27 usage in seconds

N

6

D-r1.0+

40

port 28 usage in seconds

N

6

D-r1.0+

41

port 29 usage in seconds

N

6

D-r1.0+

42

port 30 usage in seconds

N

6

D-r1.0+

43

port 31 usage in seconds

N

6

D-r1.0+

44

port 32 usage in seconds

N

6

D-r1.0+

45

port 1 peg count

N

6

D-r1.0+

46

port 2 peg count

N

6

D-r1.0+

47

port 3 peg count

N

6

D-r1.0+

48

port 4 peg count

N

6

D-r1.0+

49

port 5 peg count

N

6

D-r1.0+

50

port 6 peg count

N

6

D-r1.0+

51

port 7 peg count

N

6

D-r1.0+

52

port 8 peg count

N

6

D-r1.0+

53

port 9 peg count

N

6

D-r1.0+

54

port 10 peg count

N

6

D-r1.0+

55

port 11 peg count

N

6

D-r1.0+

56

port 12 peg count

N

6

D-r1.0+

57

port 13 peg count

N

6

D-r1.0+

58

port 14 peg count

N

6

D-r1.0+

59

port 15 peg count

N

6

D-r1.0+

60

port 16 peg count

N

6

D-r1.0+

61

port 17 peg count

N

6

D-r1.0+

62

port 18 peg count

N

6

D-r1.0+

63

port 19 peg count

N

6

D-r1.0+

64

port 20 peg count

N

6

D-r1.0+

65

port 21 peg count

N

6

D-r1.0+

66

port 22 peg count

N

6

D-r1.0+

67

port 23 peg count

N

6

D-r1.0+

68

port 24 peg count

N

6

D-r1.0+

69

port 25 peg count

N

6

D-r1.0+

70

port 26 peg count

N

6

D-r1.0+

71

port 27 peg count

N

6

D-r1.0+

72

port 28 peg count

N

6

D-r1.0+

73

port 29 peg count

N

6

D-r1.0+

74

port 30 peg count

N

6

D-r1.0+

75

port 31 peg count

N

6

D-r1.0+

76

port 32 peg count

N

6

D-r1.0+

77

total storage used (hours)

N

12.1

D-r3.2+

78

total storage free (hours)

N

12.1

D-r3.2+

79

message storage used (hours)

N

12.1

D-r3.2+

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getload

12-66
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

80

voiced name storage used (hours)

N

12.1

D-r3.2+

81

percent remote

N

2

D-r3.2+

82

announcement storage used (hours)

N

12.1

D-r3.2+

INTUITY
AUDIX
System

Example
The following command retrieves the DEFINITY AUDIX List Measurements Load
Day screen data for January 3, 1995, writes a summary of the transfer statistics
to the screen, and writes output to a file named dayloads.
getload -f day -d 010395 -v > dayloads

RETURN

The following data is written to the file:
19950103,2359,0,0,0,1,0,25,8,28743,5509,31682,31544,
31441,31521,31551,30959,31451,31699,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,379,365,383,368,354,407,
375,364,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,
16.0
,
3.1
,
12.9
,
1.0
,20,
2.1 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlog

12-67

getlog
Get activity log data

Syntax
getlog [-a y/n] -e nnnnnnnnnn [-d mmddyy [-t hhmm]]
[-s mmddyy [-h hhmm]] [-n nn] [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves data for the following screens for starting and ending
date, starting and ending time, and extension that you specify:
■

INTUITY AUDIX Display Activity-Log

■

DEFINITY AUDIX Display Activity-Log

■

R1 AUDIX (R1V5 and beyond) system : activity log : display

When used with an R1 AUDIX System, the following options are required when
retrieving data: a, e, d, t, s, h. When you want to turn off retrieval only, -a n is
required.
When used with an INTUITY or DEFINITY AUDIX System, this command does not
turn on or off the activity log (see getalogp and setalogp). Only the option e is
required. By default, all entries for the indicated extension are returned.
The screen is updated with any of the options you specify except r, v, w, or n. For
the R1 AUDIX System, ADAP updates the system : activity log : specification
screen with the date and time of the retrieval before retrieving the data. For
INTUITY or DEFINITY AUDIX Systems, ADAP updates the specification fields of
the Display Activity-Log screen while retrieving the data. The voice mail system
retains the values you supply after the retrieval is completed
.

No input is required. Retrieved data is written to standard output.

-a

Activity log (activates log capabilities) flag; must be followed by
either a y or n.

y/n

Activates or deactivates the activity log. Available only with an
R1 AUDIX System.

-e

Extension flag; must be followed by nnnnnnnnnn. This flag is
required for the INTUITY or DEFINITY AUDIX System when the -a
flag is y.

nnnnnnnnnn

Retrieves data for the specified extension.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlog

12-68

-d

Starting date flag; must be followed by mmddyy.

mmddyy

Retrieves data starting at the month, day, and year indicated by
mmddyy.

-t

Starting time flag; must be followed by hhmm. This flag is only
available if the -d flag is also used.

hhmm

Retrieves data starting from the hour and minute of the day that
you have specified already by -d mmddyy. Midnight is
represented by 0000.

-s

Ending date flag; must be followed by mmddyy.

mmddyy

Stops retrieving data at the month, day, and year indicated by
mmddyy.

-h

Ending time flag; must be followed by hhmm. This flag is only
available if the -s flag is also used.

hhmm

Stops retrieving data at the hour and minute of the day that you
have specified already by -s mmddyy. Midnight is represented
by 0000.

-n

Record number flag; must be followed by nn. This flag is
available only for the INTUITY and DEFINITY AUDIX Systems. If
this flag is not specified, all records that meet the specification
criteria will be returned.

nn

Retrieves the number (nn) of records that you specify. If the
word all is used, all records that meet the specification criteria
will be returned.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V5 and beyond) System
software. The DEFINITY AUDIX System default is D-r3.2. The
INTUITY AUDIX System default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing -v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command
into the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol > . If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlog

12-69

Errors
If the activity log was activated then deactivated, only the data prior to the
deactivation date/time is available. This is subject to the number of entries that
the system activity log holds, as specified on the INTUITY or DEFINITY AUDIX
Systems Display System-Parameters Activity-Log screen or on the R1 AUDIX
system : limits screen.
If no activity log data exists that fits the specified search, no output is written.

! CAUTION:
The following caution applies only to the R1 AUDIX System: If operators on
the local maintenance terminal (LMT) and the local administration terminal
concurrently access the same screen information, output on either terminal
could prematurely terminate or reflect other undesirable changes.

Output Format
Output for the getlog command when communicating with a DEFINITY or INTUITY
AUDIX System is formatted as follows, with one record for each log entry.

FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

8

D-r1.0+

I-r2.0+

4

D-r1.0+

I-r2.0+

C

9

D-r1.0+

I-r2.0+

C

100

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

Type

Max.
Width

1

date

D

2

time

T

3

activity

4

description

R1
AUDIX
System

Output for the getlog command when communicating with an R1 AUDIX System
is formatted as follows, with one record for each log entry

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

D

8

r1v5+

time

T

4

r1v5+

activity description

C

130

r1v5+

Seq.
No.

Field Name

1

date

2
3

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getlog

12-70

Example
The following command retrieves the INTUITY or DEFINITY AUDIX Display
Activity-Log screen data for extension 3101 for November 22, 1994, and writes
output to a file named actlog.
getlog -e 3101 -d 112294 -s 032294 > actlog

RETURN

The following data is written to the file, one line for each activity:
19941122,1822,"log-in","message counts: new=0,
unopened=0, old=0" NEWLINE
The following command retrieves the R1V8 AUDIX system : activity log : display
screen data for extension 53541 from 8:05 a.m. to 9:30 a.m. on August 27, 1994,
writes a summary of the transfer statistics to the screen, and writes output to a file
named actlog.
getlog -r r1v8 -a y -e 53541 -d 082794 -t 0805 -s 082794 -h 0930 -v >
actlog RETURN
The following data is written to the file, one line for each activity:
19940827,0926,"Message to 53541 delivered at 08/27/94
08:15 deleted." NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getmaint

12-71

getmaint
Get maintenance log data

Syntax
getmaint [-d mmddyy [-t hhmm]] [-c event id ] [-f search string ] [-A application]
[-a alarm resolution] [-E errors] [-e events] [-R reporting-resource-type]
[-T resource-type [-L location]] [-n nnnn] [-r release] [-v] [-w] [-V]
[ > ofile]

Description
This command retrieves all pages for the date, time, and search information that
you specify for the following screens:
■

INTUITY AUDIX Display Events

ADAP updates the specification fields of the INTUITY AUDIX Display
Maintenance-Log screen while retrieving the data.
If you omit the options and their qualifiers then all records from and including the
specified date and time are returned. For complete lists of errors and resource
types, see the appropriate voice mail system maintenance manual. No input is
required. All errors retrieved are written to standard output.
NOTE:
The getmaint command requires the craft login for the INTUITY AUDIX
System.

-d

Date flag; must be followed by mmddyy. This flag is required for
INTUITY AUDIX System. The default retrieves entries for all dates.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, 072294, retrieves data for July 22, 1994.

-t

Time of the day flag; must be followed by hhmm. Required for
INTUITY AUDIX System. The default retrieves all entries starting at
the specified date.

hhmm

Retrieves errors from the specified hour and minute to the current
time. For example, if you enter 1512 at 6:00 p.m. (for retrieval on
the same day), the data from 3:12 p.m. to 6:00 p.m.is retrieved.

-c

Event id flag; must be followed by event id .

event id

Retrieves errors matching the error code that you specify. See the
appropriate voice mail system maintenance manual for a list of
event ids.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getmaint

12-72

-f

Search string flag; must be followed by search string .

search
string

Retrieves errors containing the search string you specify. The
maximum string length for INTUITY AUDIX Systems is 78 characters.

-A

Application flag; must be followed with application.

application

Retrieves only records logged against this application (module),
i.e. VM.

See INTUITY Platform Administration and Maintenance for
Release 3.0-585-310-557
-a

RES alarm resolution information flag; must be followed by either y
or n. The default is y.

alarm
resolution

Retrieves or does not retrieve alarm RES (resolution) information.

-E

ERR (error) information flag; must be followed by y or n. Default is
y.

errors

Retrieves or does not retrieve ERR (error) information.

-e

EVN (event) information flag; must be followed by either y or n. The
default is y.

events

Retrieves or does not retrieve EVN (event) information.

-R

Retrieves records logged by the resource type.

reportingresourcetype

Retrieves records logged by the resource type (module) that you
specify. See the appropriate voice mail system maintenance
manual for a list of resource types.

-T

Resource type flag; must be followed with resource-type.

resourcetype

Retrieves records logged against the resource type that you
specify. See the appropriate voice mail system maintenance
manual for a list of resource types.

-L

Location flag; must be followed with location.

location

Retrieves errors logged against resources at the specified location.
The T resource-type argument must also be specified. See INTUITY
AUDIX System R3.3 Administration and Feature Operations
(585-310-552) for the format of location.

-n

Number of records flag; must be followed by nnnn.If this flag is not
specified, retrieves all records meeting specification criteria.

nnnn

Retrieves the number (nnnn) of records that you specify.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX
System software. For the INTUITY AUDIX System the default is I-r5.0.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getmaint

12-73

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the output file; filename must be preceded
by > . If no output file is specified, data is written to the screen.

Errors
If no errors match the specified search, no output is written.

Output Format
Output for the getmaint command is formatted as follows.

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

problem resource, type

C

14

I-r2.0+

2

problem resource, instance

C

3

I-r2.0+

3

problem resource, location

C

11

I-r2.0+

4

message type

C

3

I-r2.0+

5

reporting resource, type

C

14

I-r2.0+

6

reporting resource, instance

C

3

I-r2.0+

7

reporting resource, source

C

19

I-r2.0+

8

application

C

2

I-r2.0+

9

event id

C

14

I-r2.0+

10

date

D

8

I-r2.0+

11

time

T

4

I-r2.0+

12

count

C

3

I-r2.0+

13

text

C

78

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getmaint

12-74

Example
The following command retrieves the INTUITY AUDIX Display Events data from
12:25 p.m. on September 14, 1994, to the hour and minute the command was
entered, writes a summary of the transfer statistics to the screen, and writes
output to a file named errors.
getmaint -d 091494 -t 1225 -v > errors

RETURN

The following data is written to the file:
"SOFTWARE","1","","ERR","MCM","1","3222","VM",
"SOFTWARE0602",19940914,1225," 1",
"AUX1/2=0/0,109-ALARM-LOG:RAISING MIN ALARM 602 ON
SOFTWARE/1" NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getmlist

12-75

getmlist
Get machine list

Syntax
getmlist [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves all pages for the following screen:
■

INTUITY AUDIX List Machines

■

DEFINITY AUDIX List Machines

■

R1 AUDIX (R1V3 and beyond) list : machine
No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V5 and beyond) System software.
The DEFINITY AUDIX System default is D-r3.2. The INTUITY AUDIX
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified, data
is written to the screen.

! CAUTION:
The following caution applies only to AUDIX systems: If operators on the
local maintenance terminal (LMT) and the local administration terminal
(LAT) concurrently access the same screen information, output on either
terminal could prematurely terminate or reflect other undesirable changes.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getmlist

12-76

Errors
If you try to use this command with the R1 AUDIX R1V2 System, an error
message appears.

Output Format
Output for the getmlist command is as follows, one record for each machine..

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

machine name

C

10

r1v3+

D-r1.0+

I-r2.0+

2

voice id

C

3

r1v3+

D-r1.0+

I-r2.0+

3

machine type

C

12

r1v3+

D-r1.0+

I-r2.0+

4

callback number

C

3

r1v3+

D-r1.0+

I-r2.0+

Example
The following command retrieves the DEFINITY AUDIX System List Machines
screen data for all AUDIX Systems, writes a summary of the transfer statistics to
the screen, and writes output to a file named machine.
getmlist -v > machine

RETURN

The following data is written to the file, one line for each machine:
"chicago","34","amisap","1"

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-77

getnet
Get network load data

Syntax
getnet -f day [-d mmddyy] [-n nn] [-r release] [-v] [-w] [-V] [>ofile]
or
getnet -f hour [-d mmddyy] [-h hh] [-n nn] [-r release] [-v] [-w] [-V] [>ofile]

Description
This command retrieves data for the date specified for the following screens:
■

INTUITY AUDIX List Measurements Network-Load Day

■

DEFINITY AUDIX List Measurements Network-Load Day

■

R1 AUDIX (R1V3 and beyond) traffic : network load : day

This command retrieves data for the date and time specified for the following
screens:
■

INTUITY AUDIX List Measurements Network-Load Hour

■

DEFINITY AUDIX List Measurements Network-Load Hour

■

R1 AUDIX (R1V3 and beyond) traffic : network load : hour

No input is required. Retrieved data is written to standard output.

-f

Screen flag; must be followed by either day or hour.

day

Retrieves the day version of the screen.

hour

Retrieves the hour version of the screen.

-d

Date flag; must be followed by mmddyy.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 012295 without subsequently entering the
n option, only the data for January 22, 1995, will be retrieved.

-h

Time of day flag; must be followed by hh.

hh

Retrieves data for the hour of the day (hh) that you specify. For
example, if you enter 15 without subsequently entering the n option,
only the data from 3:00 p.m. to 4:00 p.m. will be retrieved.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-78

-n

Number of records flag; must be followed by nn. Omitting this flag
retrieves one record.

nn

Retrieves the number (nn) of hourly or daily records that you
specify. For example, if you want to retrieve hourly data and you
enter 15 for hh and then enter 5 for nn, the data for the hours
between 3:00 p.m. and 8:00 p.m. (the data beginning at 3:00 and
continuing through the next five hours) will be retrieved.
The same is true for daily records. If you enter 092294 for mmddyy
and then enter 8 for nn, the data from and including September 22,
1994, and continuing through September 29, 1994, will be
retrieved.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or AUDIX R1 System software. The DEFINITY
AUDIX System default is D-r3.2. The INTUITY AUDIX System default
is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

Output Format
Output for the getnet command when communicating with an INTUITY AUDIX
System using the -f day option is formatted as follows, one record for each day.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

starting date

D

8

I-r2.0+

2

ending time

T

4

I-r2.0+

3

total msg transmission threshold exceptions

N

7

I-r2.0+

4

total msg transmission limit exceptions

N

7

I-r2.0+

5

remote deliveries rescheduled

N

8

I-r2.0+

6

maximum simultaneous channels

N

3

I-r2.0+

7

total incoming calls unanswered

N

5

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-79
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

8

total remote undeliverable messages

N

8

I-r2.0+

9

network channel 1 type

C

6

I-r2.0+

10

network channel 1 usage, incoming

N

7

I-r2.0+

11

network channel 1 usage, outgoing

N

7

I-r2.0+

12

network channel 1 usage, total

N

7

I-r2.0+

13

network channel 1 peg count, incoming

N

6

I-r2.0+

14

network channel 1 peg count, outgoing

N

6

I-r2.0+

15

network channel 1 peg count, total

N

6

I-r2.0+

16

network channel 2 type

C

6

I-r2.0+

17

network channel 2 usage, incoming

N

7

I-r2.0+

18

network channel 2 usage, outgoing

N

7

I-r2.0+

19

network channel 2 usage, total

N

7

I-r2.0+

20

network channel 2 peg count, incoming

N

6

I-r2.0+

21

network channel 2 peg count, outgoing

N

6

I-r2.0+

22

network channel 2 peg count, total

N

6

I-r2.0+

23

network channel 3 type

C

6

I-r2.0+

24

network channel 3 usage, incoming

N

7

I-r2.0+

25

network channel 3 usage, outgoing

N

7

I-r2.0+

26

network channel 3 usage, total

N

7

I-r2.0+

27

network channel 3 peg count, incoming

N

6

I-r2.0+

28

network channel 3 peg count, outgoing

N

6

I-r2.0+

29

network channel 3 peg count, total

N

6

I-r2.0+

30

network channel 4 type

C

6

I-r2.0+

31

network channel 4 usage, incoming

N

7

I-r2.0+

32

network channel 4 usage, outgoing

N

7

I-r2.0+

33

network channel 4 usage, total

N

7

I-r2.0+

34

network channel 4 peg count, incoming

N

6

I-r2.0+

35

network channel 4 peg count, outgoing

N

6

I-r2.0+

36

network channel 4 peg count, total

N

6

I-r2.0+

37

network channel 5 type

C

6

I-r2.0+

38

network channel 5 usage, incoming

N

7

I-r2.0+

39

network channel 5 usage, outgoing

N

7

I-r2.0+

40

network channel 5 usage, total

N

7

I-r2.0+

41

network channel 5 peg count, incoming

N

6

I-r2.0+

42

network channel 5 peg count, outgoing

N

6

I-r2.0+

43

network channel 5 peg count, total

N

6

I-r2.0+

44

network channel 6 type

C

6

I-r2.0+

45

network channel 6 usage, incoming

N

7

I-r2.0+

46

network channel 6 usage, outgoing

N

7

I-r2.0+

47

network channel 6 usage, total

N

7

I-r2.0+

48

network channel 6 peg count, incoming

N

6

I-r2.0+

49

network channel 6 peg count, outgoing

N

6

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-80
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

50

network channel 6 peg count, total

N

6

I-r2.0+

51

network channel 7 type

C

6

I-r2.0+

52

network channel 7 usage, incoming

N

7

I-r2.0+

53

network channel 7 usage, outgoing

N

7

I-r2.0+

54

network channel 7 usage, total

N

7

I-r2.0+

55

network channel 7 peg count, incoming

N

6

I-r2.0+

56

network channel 7 peg count, outgoing

N

6

I-r2.0+

57

network channel 7 peg count, total

N

6

I-r2.0+

58

network channel 8 type

C

6

I-r2.0+

59

network channel 8 usage, incoming

N

7

I-r2.0+

60

network channel 8 usage, outgoing

N

7

I-r2.0+

61

network channel 8 usage, total

N

7

I-r2.0+

62

network channel 8 peg count, incoming

N

6

I-r2.0+

63

network channel 8 peg count, outgoing

N

6

I-r2.0+

64

network channel 8 peg count, total

N

6

I-r2.0+

65

network channel 9 type

C

6

I-r2.0+

66

network channel 9 usage, incoming

N

7

I-r2.0+

67

network channel 9 usage, outgoing

N

7

I-r2.0+

68

network channel 9 usage, total

N

7

I-r2.0+

69

network channel 9 peg count, incoming

N

6

I-r2.0+

70

network channel 9 peg count, outgoing

N

6

I-r2.0+

71

network channel 9 peg count, total

N

6

I-r2.0+

72

network channel 10 type

C

6

I-r2.0+

73

network channel 10 usage, incoming

N

7

I-r2.0+

74

network channel 10 usage, outgoing

N

7

I-r2.0+

75

network channel 10 usage, total

N

7

I-r2.0+

76

network channel 10 peg count, incoming

N

6

I-r2.0+

77

network channel 10 peg count, outgoing

N

6

I-r2.0+

78

network channel 10 peg count, total

N

6

I-r2.0+

79

network channel 11 type

C

6

I-r2.0+

80

network channel 11 usage, incoming

N

7

I-r2.0+

81

network channel 11 usage, outgoing

N

7

I-r2.0+

82

network channel 11 usage, total

N

7

I-r2.0+

83

network channel 11 peg count, incoming

N

6

I-r2.0+

84

network channel 11 peg count, outgoing

N

6

I-r2.0+

85

network channel 11 peg count, total

N

6

I-r2.0+

86

network channel 12 type

C

6

I-r2.0+

87

network channel 12 usage, incoming

N

7

I-r2.0+

88

network channel 12 usage, outgoing

N

7

I-r2.0+

89

network channel 12 usage, total

N

7

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-81
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

90

network channel 12 peg count, incoming

N

6

I-r2.0+

91

network channel 12 peg count, outgoing

N

6

I-r2.0+

92

network channel 12 peg count, total

N

6

I-r2.0+

Output for the getnet command when communicating with a DEFINITY AUDIX
System using the -f day option is formatted as follows, one record for each day.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

starting date

D

8

D-r3.2+

2

ending time

T

4

D-r3.2+

3

total msg transmission threshold exceptions

N

7

D-r3.2+

4

total msg transmission limit exceptions

N

7

D-r3.2+

5

remote deliveries rescheduled

N

8

D-r3.2+

6

maximum simultaneous channels

N

3

D-r3.2+

7

total incoming calls unanswered

N

5

D-r3.2+

8

total remote undeliverable messages

N

8

D-r3.2+

9

network channel 1 usage, incoming

N

7

D-r3.2+

10

network channel 1 usage, outgoing

N

7

D-r3.2+

11

network channel 1 usage, total

N

7

D-r3.2+

12

network channel 1 peg count, incoming

N

6

D-r3.2+

13

network channel 1 peg count, outgoing

N

6

D-r3.2+

14

network channel 1 peg count, total

N

6

D-r3.2+

15

network channel 2 usage, incoming

N

7

D-r3.2+

16

network channel 2 usage, outgoing

N

7

D-r3.2+

17

network channel 2 usage, total

N

7

D-r3.2+

18

network channel 2 peg count, incoming

N

6

D-r3.2+

19

network channel 2 peg count, outgoing

N

6

D-r3.2+

20

network channel 2 peg count, total

N

6

D-r3.2+

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-82

Output for the getnet command when communicating with an R1 AUDIX System
using the -f day option is formatted as follows, with one record for each day.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

D

8

r1v3+

ending time

T

4

r1v3+

total msg transmission threshold exceptions

N

7

r1v3+

4

total msg transmission limit exceptions

N

7

r1v3+

5

remote deliveries rescheduled

N

8

r1v3+

6

maximum simultaneous ports

N

3

r1v3+

7

total remote undeliverable messages

N

8

r1v3+

8

data port 1 usage, incoming

N

7

r1v3+

9

data port 2 usage, incoming

N

7

r1v3+

10

data port 3 usage, incoming

N

7

r1v3+

11

data port 4 usage, incoming

N

7

r1v3+

12

data port 1 usage, outgoing

N

7

r1v3+

13

data port 2 usage, outgoing

N

7

r1v3+

14

data port 3 usage, outgoing

N

7

r1v3+

15

data port 4 usage, outgoing

N

7

r1v3+

16

data port 1 peg count, incoming

N

6

r1v3+

17

data port 2 peg count, incoming

N

6

r1v3+

18

data port 3 peg count, incoming

N

6

r1v3+

19

data port 4 peg count, incoming

N

6

r1v3+

20

data port 1 peg count, outgoing

N

6

r1v3+

21

data port 2 peg count, outgoing

N

6

r1v3+

22

data port 3 peg count, outgoing

N

6

r1v3+

23

data port 4 peg count, outgoing

N

6

r1v3+

24

total incoming calls unanswered

N

5

r1v5+

25

data port 1 usage, total

N

7

r1v5+

26

data port 2 usage, total

N

7

r1v5+

27

data port 3 usage, total

N

7

r1v5+

28

data port 4 usage, total

N

7

r1v5+

29

data port 1 peg count, total

N

6

r1v5+

30

data port 2 peg count, total

N

6

r1v5+

31

data port 3 peg count, total

N

6

r1v5+

32

data port 4 peg count, total

N

6

r1v5+

33

data port 5 usage, incoming

N

7

r1v5+

34

data port 5 usage, outgoing

N

7

r1v5+

35

data port 5 usage, total

N

7

r1v5+

36

data port 5 peg count, incoming

N

6

r1v5+

37

data port 5 peg count, outgoing

N

6

r1v5+

38

data port 5 peg count, total

N

6

r1v5+

Seq.
No.

Field Name

1

starting date

2
3

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-83
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

39

data port 6 usage, incoming

N

7

r1v5+

40

data port 6 usage, outgoing

N

7

r1v5+

41

data port 6 usage, total

N

7

r1v5+

42

data port 6 peg count, incoming

N

6

r1v5+

43

data port 6 peg count, outgoing

N

6

r1v5+

44

data port 6 peg count, total

N

6

r1v5+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Output for the getnet command when communicating with an INTUITY AUDIX
System using the -f hour option is formatted as follows, with one record for each
hour.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

starting date

D

8

I-r2.0+

2

hour

N

2

I-r2.0+

3

ending time

T

4

I-r2.0+

4

total msg transmission threshold exceptions

N

7

I-r2.0+

5

total msg transmission limit exceptions

N

7

I-r2.0+

6

remote deliveries rescheduled

N

8

I-r2.0+

7

maximum simultaneous channels

N

3

I-r2.0+

8

total incoming calls unanswered

N

5

I-r2.0+

9

total remote undeliverable messages

N

8

I-r2.0+

10

network channel 1 type

C

6

I-r2.0+

11

network channel 1 usage, incoming

N

7

I-r2.0+

12

network channel 1 usage, outgoing

N

7

I-r2.0+

13

network channel 1 usage, total

N

7

I-r2.0+

14

network channel 1 peg count, incoming

N

6

I-r2.0+

15

network channel 1 peg count, outgoing

N

6

I-r2.0+

16

network channel 1 peg count, total

N

6

I-r2.0+

17

network channel 2 type

C

6

I-r2.0+

Seq. No.

18

network channel 2 usage, incoming

N

7

I-r2.0+

19

network channel 2 usage, outgoing

N

7

I-r2.0+

20

network channel 2 usage, total

N

7

I-r2.0+

21

network channel 2 peg count, incoming

N

6

I-r2.0+

22

network channel 2 peg count, outgoing

N

6

I-r2.0+

23

network channel 2 peg count, total

N

6

I-r2.0+

24

network channel 3 type

C

6

I-r2.0+

25

network channel 3 usage, incoming

N

7

I-r2.0+

26

network channel 3 usage, outgoing

N

7

I-r2.0+

27

network channel 3 usage, total

N

7

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-84
FIELD

Seq. No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

28

network channel 3 peg count, incoming

N

6

I-r2.0+

29

network channel 3 peg count, outgoing

N

6

I-r2.0+

30

network channel 3 peg count, total

N

6

I-r2.0+

31

network channel 4 type

C

6

I-r2.0+

32

network channel 4 usage, incoming

N

7

I-r2.0+

33

network channel 4 usage, outgoing

N

7

I-r2.0+

34

network channel 4 usage, total

N

7

I-r2.0+

35

network channel 4 peg count, incoming

N

6

I-r2.0+

36

network channel 4 peg count, outgoing

N

6

I-r2.0+

37

network channel 4 peg count, total

N

6

I-r2.0+

38

network channel 5 type

C

6

I-r2.0+

39

network channel 5 usage, incoming

N

7

I-r2.0+

40

network channel 5 usage, outgoing

N

7

I-r2.0+

41

network channel 5 usage, total

N

7

I-r2.0+

42

network channel 5 peg count, incoming

N

6

I-r2.0+

43

network channel 5 peg count, outgoing

N

6

I-r2.0+

44

network channel 5 peg count, total

N

6

I-r2.0+

45

network channel 6 type

C

6

I-r2.0+

46

network channel 6 usage, incoming

N

7

I-r2.0+

47

network channel 6 usage, outgoing

N

7

I-r2.0+

48

network channel 6 usage, total

N

7

I-r2.0+

49

network channel 6 peg count, incoming

N

6

I-r2.0+

50

network channel 6 peg count, outgoing

N

6

I-r2.0+

51

network channel 6 peg count, total

N

6

I-r2.0+

52

network channel 7 type

C

6

I-r2.0+

53

network channel 7 usage, incoming

N

7

I-r2.0+

54

network channel 7 usage, outgoing

N

7

I-r2.0+

55

network channel 7 usage, total

N

7

I-r2.0+

56

network channel 7 peg count, incoming

N

6

I-r2.0+

57

network channel 7 peg count, outgoing

N

6

I-r2.0+

58

network channel 7 peg count, total

N

6

I-r2.0+

59

network channel 8 type

C

6

I-r2.0+

60

network channel 8 usage, incoming

N

7

I-r2.0+

61

network channel 8 usage, outgoing

N

7

I-r2.0+

62

network channel 8 usage, total

N

7

I-r2.0+

63

network channel 8 peg count, incoming

N

6

I-r2.0+

64

network channel 8 peg count, outgoing

N

6

I-r2.0+

65

network channel 8 peg count, total

N

6

I-r2.0+

66

network channel 9 type

C

6

I-r2.0+

67

network channel 9 usage, incoming

N

7

I-r2.0+

68

network channel 9 usage, outgoing

N

7

I-r2.0+

69

network channel 9 usage, total

N

7

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-85
FIELD

Seq. No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

70

network channel 9 peg count, incoming

N

6

I-r2.0+

71

network channel 9 peg count, outgoing

N

6

I-r2.0+

72

network channel 9 peg count, total

N

6

I-r2.0+

73

network channel 10 type

C

6

I-r2.0+

74

network channel 10 usage, incoming

N

7

I-r2.0+

75

network channel 10 usage, outgoing

N

7

I-r2.0+

76

network channel 10 usage, total

N

7

I-r2.0+

77

network channel 10 peg count, incoming

N

6

I-r2.0+

78

network channel 10 peg count, outgoing

N

6

I-r2.0+

79

network channel 10 peg count, total

N

6

I-r2.0+

80

network channel 11 type

C

6

I-r2.0+

81

network channel 11 usage, incoming

N

7

I-r2.0+

82

network channel 11 usage, outgoing

N

7

I-r2.0+

83

network channel 11 usage, total

N

7

I-r2.0+

84

network channel 11 peg count, incoming

N

6

I-r2.0+

85

network channel 11 peg count, outgoing

N

6

I-r2.0+

86

network channel 11 peg count, total

N

6

I-r2.0+

87

network channel 12 type

C

6

I-r2.0+

88

network channel 12 usage, incoming

N

7

I-r2.0+

89

network channel 12 usage, outgoing

N

7

I-r2.0+

90

network channel 12 usage, total

N

7

I-r2.0+

91

network channel 12 peg count, incoming

N

6

I-r2.0+

92

network channel 12 peg count, outgoing

N

6

I-r2.0+

93

network channel 12 peg count, total

N

6

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-86

Output for the getnet command when communicating with a DEFINITY AUDIX
system using the -f hour option is formatted as follows, with one record for each
hour.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

starting date

D

8

D-r3.2+

2

starting hour

N

2

D-r3.2+

3

ending time

T

4

D-r3.2+

4

total msg transmission threshold exceptions

N

7

D-r3.2+

5

total msg transmission limit exceptions

N

7

D-r3.2+

6

remote deliveries rescheduled

N

8

D-r3.2+

7

maximum simultaneous channels

N

3

D-r3.2+

8

total incoming calls unanswered

N

5

D-r3.2+

9

total remote undeliverable messages

N

8

D-r3.2+

10

network channel 1 usage, incoming

N

7

D-r3.2+

11

network channel 1 usage, outgoing

N

7

D-r3.2+

12

network channel 1 usage, total

N

7

D-r3.2+

13

network channel 1 peg count, incoming

N

6

D-r3.2+

14

network channel 1 peg count, outgoing

N

6

D-r3.2+

15

network channel 1 peg count, total

N

6

D-r3.2+

16

network channel 2 usage, incoming

N

7

D-r3.2+

17

network channel 2 usage, outgoing

N

7

D-r3.2+

18

network channel 2 usage, total

N

7

D-r3.2+

19

network channel 2 peg count, incoming

N

6

D-r3.2+

20

network channel 2 peg count, outgoing,

N

6

D-r3.2+

21

network channel 2 peg count, total

N

6

D-r3.2+

INTUITY
AUDIX
System

Output for the getnet command when communicating with an R1 AUDIX System
using the -f hour option is formatted as follows, with one record for each hour.

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

D

8

r1v3+

starting hour

N

2

r1v3+

3

ending time

T

4

r1v3+

4

total msg transmission threshold exceptions

N

7

r1v3+

5

total msg transmission limit exceptions

N

7

r1v3+

6

remote deliveries rescheduled

N

8

r1v3+

7

maximum simultaneous ports

N

3

r1v3+

8

total remote undeliverable messages

N

8

r1v3+

Seq.
No.

Field Name

1

starting date

2

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-87
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

9

data port 1 usage, incoming

N

7

r1v3+

10

data port 2 usage, incoming

N

7

r1v3+

11

data port 3 usage, incoming

N

7

r1v3+

12

data port 4 usage, incoming

N

7

r1v3+

13

data port 1 usage, outgoing

N

7

r1v3+

14

data port 2 usage, outgoing

N

7

r1v3+

15

data port 3 usage, outgoing

N

7

r1v3+

16

data port 4 usage, outgoing

N

7

r1v3+

17

data port 1 peg count, incoming

N

6

r1v3+

18

data port 2 peg count, incoming

N

6

r1v3+

19

data port 3 peg count, incoming

N

6

r1v3+

20

data port 4 peg count, incoming

N

6

r1v3+

21

data port 1 peg count, outgoing

N

6

r1v3+

22

data port 2 peg count, outgoing

N

6

r1v3+

23

data port 3 peg count, outgoing

N

6

r1v3+

24

data port 4 peg count, outgoing

N

6

r1v3+

25

total incoming calls unanswered

N

5

r1v5+

26

data port 1 usage, total

N

7

r1v5+

27

data port 2 usage, total

N

7

r1v5+

28

data port 3 usage, total

N

7

r1v5+

29

data port 4 usage, total

N

7

r1v5+

30

data port 1 peg count, total

N

6

r1v5+

31

data port 2 peg count, total

N

6

r1v5+

32

data port 3 peg count, total

N

6

r1v5+

33

data port 4 peg count, total

N

6

r1v5+

34

data port 5 usage, incoming

N

7

r1v5+

35

data port 5 usage, outgoing

N

7

r1v5+

36

data port 5 usage, total

N

7

r1v5+

37

data port 5 peg count, incoming

N

6

r1v5+

38

data port 5 peg count, outgoing

N

6

r1v5+

39

data port 5 peg count, total

N

6

r1v5+

40

data port 6 usage, incoming

N

7

r1v5+

41

data port 6 usage, outgoing

N

7

r1v5+

42

data port 6 usage, total

N

7

r1v5+

43

data port 6 peg count, incoming

N

6

r1v5+

44

data port 6 peg count, outgoing

N

6

r1v5+

45

data port 6 peg count, total

N

6

r1v5+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getnet

12-88

Example
The following command retrieves the traffic : network load : day screen data for
May 22, 1994, displays a transfer statistics summary, and writes output to a file
named daylds.
getnet -r r1v8 -f day -d 052294 -v > daylds

RETURN

The following data is written to the file:
19940522,2359,0,0,19,3,1,4494,167,0,0,0,70,514,4583,
162,7,0,0,0,10,30,171,0,4494,237,514,4583,162,17,30,
171,0,0,0,0,0,0,0,0,0,0,0,0 RETURN

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-89

getperf
Get performance data

Syntax
getperf [-d] [-f] [-D mmddyy] [-t hh] [-n nn][-r release] [-N] [-v] [-w] [-V] [> ofile]

Description
This command retrieves the INTUITY AUDIX, DEFINITY AUDIX, or the R1 AUDIX
(R1V5 and beyond) System performance data.
Retrieved data is written to standard output.

-D

Date flag; must be followed by mmddyy. This flag is valid only for
the INTUITY and DEFINITY AUDIX Systems. It is required by INTUITY
and DEFINITY AUDIX Systems.

mmddyy

Retrieves data for the month day and year indicated by mmddyy.

-t

Hour flag; must be followed by hh. Valid only for the INTUITY and
DEFINITY AUDIX Systems.

hh

Retrieves data starting on the hour specified by hh on the date you
specified by -D mmddyy. The default is 0.

-n

Hours of data flag; must be followed by nn. This flag is valid only
for the INTUITY and DEFINITY AUDIX Systems.

nn

Retrieves the number of hours of data specified by nn starting on
the hour specified by -h hh on the date you specified by -D
mmddyy. You also may specify all to get all the hours on and after
the date and time specified. The default is 1.

-d

Indicates that only DBP data is read. This flag is valid only for R1
AUDIX Systems.

-f

Indicates that only FP/VSP data is read. This flag is valid only for
R1 AUDIX Systems.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V5 and beyond) System
software. The default for the DEFINITY AUDIX System is D-r3.2.
The default for the INTUITY AUDIX System is I-r5.0.

-N

The -N option is for R1 AUDIX systems only and allows the getperf
command to retrieve the network performance data. The -N option
must follow the -r option.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-90

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, getperf.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.
NOTE:
During a system reboot, performance data is reset.
NOTE:
There is some system performance impact on the R1 AUDIX System
if the data is retrieved during busy hours. It may require up to 5
minutes to retrieve all of the data. During the retrieval of data, the FP
occupancy is 10% to 15% higher than without the data retrieval.
NOTE:
The following note applies only to the R1 AUDIX System:
In order to retrieve FP and VSP performance statistics, the R1
AUDIX System cabinet must be equipped with a TN591 Vintage 1
CPU. The board should reside in slot #9 for AUDIX-Small, slot #9 of
lower and upper carriers for AUDIX-Tower, and slot #3 and #12 for
AUDIX-Large. If the board is not present, a message appears on
the screen indicating the required board is not present.

Errors
An error message appears on the screen and the command aborts if you try to
use the getperf command with a release of the R1 AUDIX System prior to R1V5.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-91

Output Format
Output for the performance data is formatted as follows:
Each peg, statistic, and histogram and INTUITY AUDIX System or DEFINITY
AUDIX System processor occupancy record contains:
"label", "type", data value, data value, . . .
Each R1 AUDIX System processor occupancy record contains:
"label", "type", date, time, data value, data value,
. . . .
NOTE:
The getperf command only supports the default delimter of double quote
(") and will not recognize the environment variable named DLIM if DLIM is
set to a character other than double quote.

General Information
In the R1 AUDIX System, performance pegs and statistics are kept from boot
time: CPU occupancy is kept for the previous 24 hours. In the INTUITY and
DEFINITY AUDIX Systems, hourly performance data is kept for the previous 8
days.

Example
The following command retrieves the DEFINITY AUDIX Systems’ performance
data for May 5, 1995, and writes output to a file named perfdata.
getperf -D 050595 > perfdata

RETURN

The following data is written to the file for the DEFINITY AUDIX System:
"MFB NUMBER","BOARD_NUM","embed"
"TIME_OF_DAY","TOD",19950505,0000
"MFB_OCCUPANCY","CPU_DATA",21.2,24.7,20.2,26.9,25.7,26.2,24.3,27.2,23.4,
22.9,22.7,26.9

"PF_GUEST_CONNECT_PEG","PEG",0
"PF_LWC_CONNECT_PEG","PEG",0
"PF_TRANSFER_PEG","PEG",0
"PF_HELP_PEG","PEG",0
"PF_WAIT_PEG","PEG",0
"PF_TOKEN_PEG","PEG",172
"PF_DA_TOKEN_PEG","PEG",0
"PF_INVCOM_PEG","PEG",0
"PF_COM_ACT_PEG","PEG",121
"PF_SIM_ACT_PEG","PEG",142
"PF_GA_ACT_PEG","PEG",0
"PF_SOM_ACT_PEG","PEG",9
"PF_SA_ACT_PEG","PEG",0
"PF_OC_ACT_PEG","PEG",0

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-92

"PF_AMS_ACT_PEG","PEG",0
"PF_SY_ACT_PEG","PEG",0
"PF_EXT_ADDR_PEG","PEG",120
"PF_NAME_ADDR_PEG","PEG",0
"PF_LIST_ADDR_PEG","PEG",0
"PF_SKIPCAT_PEG","PEG",0
"PF_FWD_PEG","PEG",0
"PF_VM_REPLY_PEG","PEG",0
"PF_XFER_REPLY_PEG","PEG",0
"PF_CREATE_LIST_PEG","PEG",0
"PF_ND_SENT_PEG","PEG",0
"PF_ND_RECD_PEG","PEG",0
"PF_FMBOX_PEG","PEG",0
"PF_RCP_STATS","PUDSTAT",0,0,0,0,0
"PF_RCP_HIST","PDBLBLANK",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_CLMS_STATS","PUDSTAT",0,0,0,0,0
"PF_COM_STATS","PTSTAT",54.17,101.57,121,9429.63,758518.99
"PF_SIM_STATS","PTSTAT",2.29,812.32,142,8914.87,2027780.03
"PF_GA_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_SOM_STATS","PTSTAT",9.31,132.40,9,563.75,50349.35
"PF_SA_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_OC_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_AMS_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_SY_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_DEL_STATS","PTSTAT",0.02,0.16,104,3.80,0.06
"PF_UNDEL_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_QMAIL_STATS","PTSTAT",0.00,0.15,120,3.37,0.05
"PF_N_VBACK_STATS","PTSTAT",0.03,0.69,273,26.19,3.18
"PF_MSGAPP_STATS","PTSTAT",0.05,0.71,120,11.68,1.30
"PF_FWD_MSGAPP_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_REPLY_MSGAPP_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_DEL_HIST","PONESECOND",0,104,0,0,0,0,0,0,0,0,0,0
"PF_UNDEL_HIST","PONESECOND",0,0,0,0,0,0,0,0,0,0,0,0
"PF_Q_MAIL_HIST","PONESECOND",0,120,0,0,0,0,0,0,0,0,0,0
"PF_NVBACK_HIST","PONESECOND",0,273,0,0,0,0,0,0,0,0,0,0
"PF_MSGAPP_HIST","PONESECOND",0,120,0,0,0,0,0,0,0,0,0,0
"PF_FWD_MSGAPP_HIST","PONESECOND",0,0,0,0,0,0,0,0,0,0,0,0
"PF_REPLY_MSGAPP_HIST","PONESECOND",0,0,0,0,0,0,0,0,0,0,0,0
"PF_MRCRD_STATS","PTSTAT",32.14,79.20,120,6720.32,399611.75
"PF_BC_UPD_STATS","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_VM_MSG_LGTH_HIST","PDBLBLANK",0,0,78,42,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0

"PF_VM_MSG_LGTH_STATS","PUDSTAT",30,77,120,6471,372375
"PF_CA_MSG_LGTH_HIST","PDBLBLANK",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0

"PF_CA_MSG_LGTH_STATS","PUDSTAT",0,0,0,0,0
"PF_MWI_ON_STATS","PUDSTAT",1,22,46,166,1394
"PF_MWI_ON_HIST","PDBLBLANK",0,0,3,29,5,2,1,2,0,0,0,0,0,0,0,2,1,0,0,0,0,1
"PF_MWI_OFF_STATS","PUDSTAT",1,12,39,105,477
"PF_MWI_OFF_HIST","PDBLBLANK",0,0,4,26,4,2,0,1,0,0,0,0,1,1,0,0,0,0,0,0,0,0
"API_STATS_add_remote_subscriber","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_add_subscriber","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_add_to_list","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_admin_login","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_change_password","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_change_play_position","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_change_play_speed","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_change_play_volume","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_check_new_messages","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_connect","PTSTAT",0.00,0.00,0,0.00,0.00

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-93

"API_STATS_connect_voice_port","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_create_list","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_delete_greeting","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_delete_list","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_delete_message","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_delete_subscriber","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_deliver_ca_message","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_deliver_message","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_disconnect","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_disconnect_voice_port","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_admin_data","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_greeting_map","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_list","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_list_ids","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_mailbox_status","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_message_component","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_message_header","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_outcall_data","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_session_data","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_subscriber_directory_block","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_subscriber_directory_entry","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_subscriber_id_by_name","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_subscriber_id_by_number","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_subscriber_id_by_ttname","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_usage_data","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_get_voice_port_status","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_install_greeting","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_install_name","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_logout","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_play_message","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_play_prompt","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_put_admin_data","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_put_annotation","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_put_greeting_map","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_put_message_component","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_put_outcall_data","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_put_prompt","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_remove_from_list","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_retrieve_greeting","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_retrieve_name","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_start_record","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_stop_play","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_stop_record","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_subscriber_login","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_transfer","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_update_message_status","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_update_subscriber","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_SESSION","STAT",0,0,0,0,0
"API_STATS_TOTAL_connect_voice_port","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_TOTAL_get_message_component","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_TOTAL_put_message_component","PTSTAT",0.00,0.00,0,0.00,0.00
"API_STATS_TOTAL_put_prompt","PTSTAT",0.00,0.00,0,0.00,0.00
"PF_RM_SENT_PEG","PEG",32
"PF_RM_RECD_PEG","PEG",15
"PF_SBS_SENT_PEG","PEG",0
"PF_SBS_RECD_PEG","PEG",0
"PF_VS_SENT_PEG","PEG",0
"PF_VS_RECD_PEG","PEG",0
"PF_ND_SENT_PEG","PEG",0
"PF_ND_RECD_PEG","PEG",0

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-94

"PF_XMT_SENT_PEG","PEG",32
"PF_XMT_RECD_PEG","PEG",15
"PF_DD_STATS","PUDSTAT",98,584,32,9058,3121136
"PF_DD_HIST","PDBLBLANK",0,21,11,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
The following command retrieves all of the R1V8 AUDIX System performance
data and writes output to a file named perfdata.
getperf -r r1v8 > perfdata

RETURN

The following data is written to the file perfdata:
"TIME_OF_DAY","TOD",19950329,1059
"TIME_SINCE_BOOT","PERF_TIME",071,2024
"PF_GUEST_CONNECT_PEG","PEG",5
"PF_LWC_CONNECT_PEG","PEG",1503
"PF_TRANSFER_PEG","PEG",19726
"PF_HELP_PEG","PEG",0
"PF_WAIT_PEG","PEG",0
"PF_TOKEN_PEG","PEG",0
"PF_DA_TOKEN_PEG","PEG",0
"PF_INVCOM_PEG","PEG",9413
"PF_COMM_ACT_PEG","PEG",9767
"PF_SIM_ACT_PEG","PEG",184990
"PF_GA_ACT_PEG","PEG",10754
"PF_SOM_ACT_PEG","PEG",499
"PF_SA_ACT_PEG","PEG",1132
"PF_OC_ACT_PEG","PEG",235
"PF_SY_ACT_PEG","PEG",93
"PF_EXT_ADDR_PEG","PEG",29999
"PF_NAME_ADDR_PEG","PEG",1041
"PF_LIST_ADDR_PEG","PEG",2210
"PF_SKIPCAT_PEG","PEG",685
"PF_FWD_PEG","PEG",8205
"PF_VM_REPLY_PEG","PEG",6732
"PF_XFER_REPLY_PEG","PEG",1968
"PF_CREATE_LIST_PEG","PEG",124
"PF_ND_SENT_PEG","PEG",2405
"PF_ND_RECD_PEG","PEG",3451
"PF_FMBOX_PEG","PEG",764
"PF_AMS_ACT_PEG","PEG",162
"PF_RCP_STATS","PUDSTAT",125,2,7321,56226,0
"PF_RCP_HIST","PDBLBLANK",5669,894,556,51,40,81,3,0,0,6,3,12,6,0,0,0,0,0,
0,0

"PF_CLMS_STATS","PUDSTAT",70,1,124,1382,0
"PF_COM_STATS","PTSTAT",1118.70,1.22,9767,1079629.74,0
"PF_SIM_STATS","PTSTAT",3902.90,0.44,184991,18821914.16,0
"PF_SOM_STATS","PTSTAT",330.70,0.16,499,14941.18,0
"PF_SA_STATS","PTSTAT",1252.04,0.98,1132,83214.60,0
"PF_OC_STATS","PTSTAT",360.32,0.42,235,7832.56,0
"PF_GA_STATS","PTSTAT",777.70,0.10,10754,594049.72,0
"PF_SY_STATS","PTSTAT",124.90,0.56,93,679.36,0
"PF_DEL_HIST","PONESECOND",160145,105110,17919,3868,1070,364,125,47,16,13
"PF_Q_MAIL_HIST","PONESECOND",9677,9788,2083,483,112,33,7,4,1,2
"PF_NVBACK_HIST","PONESECOND",201472,1209,384,250,269,373,1314,1469,466,
129

"PF_MRCRD_STATS","PTSTAT",0.00,0.00,0,0.00,0
"PF_BC_UPD_STATS","PTSTAT",491.64,426.70,3,1360.54,0
"PF_AMS_STATS","PTSTAT",1179.30,0.74,162,19944.60,0

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-95

"PF_DD_STATS","PUDSTAT",448445,14,17694,18186163,0
"PF_DD_HIST","PDBLBLANK",9035,5968,1393,390,215,114,86,67,22,34,16,25,55,
55,88,52,17,8,10,44

"FP_OCCUPANCY","CPU_DATA",19950328,1055,58.2,51.8,62.5,50.9,61.6,47.1,
55.2,49.7,42.0,39.0,33.9,36.9

"FP_OCCUPANCY","CPU_DATA",19950328,1155,45.4,42.8,47.9,52.6,43.7,57.8,
61.2,57.3,47.5,55.6,47.5,46.7

"FP_OCCUPANCY","CPU_DATA",19950328,1255,54.8,64.6,55.2,41.5,40.7,45.0,
45.8,40.3,44.5,42.8,51.4,45.0

"FP_OCCUPANCY","CPU_DATA",19950328,1355,42.4,39.0,44.1,47.1,38.1,39.0,
43.3,46.2,42.8,42.0,49.2,46.7

"FP_OCCUPANCY","CPU_DATA",19950328,1455,53.1,46.2,47.9,41.5,27.9,38.1,
42.0,46.2,34.7,42.0,42.4,36.9

"FP_OCCUPANCY","CPU_DATA",19950328,1555,41.5,42.4,37.7,31.7,30.5,33.0,
24.5,24.9,24.5,22.8,27.0,32.6

"FP_OCCUPANCY","CPU_DATA",19950328,1655,38.1,43.7,36.4,24.1,15.9,23.6,
16.8,14.2,19.8,17.7,25.8,14.2

"FP_OCCUPANCY","CPU_DATA",19950328,1755,13.8,9.1,16.4,14.2,14.2,15.5,10.4,
9.5,9.5,9.5,7.4,9.1

"FP_OCCUPANCY","CPU_DATA",19950328,1855,7.8,9.5,23.2,34.3,33.9,34.3,35.6,
31.3,33.9,36.9,37.3,36.0

"FP_OCCUPANCY","CPU_DATA",19950328,1955,36.0,32.6,38.6,28.7,27.9,28.7,
30.0,36.9,33.9,32.6,32.2,29.2

"FP_OCCUPANCY","CPU_DATA",19950328,2055,30.5,28.7,34.7,44.5,42.0,43.7,
42.0,39.0,41.1,43.7,42.0,45.4

"FP_OCCUPANCY","CPU_DATA",19950328,2155,48.4,30.0,23.2,30.9,27.5,22.3,
17.7,15.1,14.7

"FP_OCCUPANCY","CPU_DATA",19950328,2255,15.9,16.8,13.8,13.8,13.8,13.4,
11.3,16.8,17.2,18.5,18.1,24.5

"FP_OCCUPANCY","CPU_DATA",19950328,2355,26.6,10.8,8.7,8.3,9.5,12.1,10.4,
9.5,8.7,9.5,5.3,7.0

"FP_OCCUPANCY","CPU_DATA",19950329,0055,5.3,7.4,7.0,7.4,5.3,5.3,5.7,7.0,
5.7,7.0,7.0,5.3

"FP_OCCUPANCY","CPU_DATA",19950329,0155,5.7,12.1,7.0,4.9,7.0,6.6,6.6,7.4,
4.9,4.9,5.7,5.7

"FP_OCCUPANCY","CPU_DATA",19950329,0255,5.3,7.4,7.0,6.6,6.1,5.3,6.1,6.1,
4.9,6.6,7.8,6.6

"FP_OCCUPANCY","CPU_DATA",19950329,0355,6.6,6.6,5.3,7.0,6.1,6.6,7.8,7.8,
6.1,6.1,6.1,6.6

"FP_OCCUPANCY","CPU_DATA",19950329,0455,8.3,7.8,10.0,7.8,10.4,7.4,7.4,8.3,
8.3,9.1,13.4,10.8

"FP_OCCUPANCY","CPU_DATA",19950329,0555,16.8,17.7,20.2,18.1,13.8,18.1,
21.5,30.0,24.9,24.9,26.6

"FP_OCCUPANCY","CPU_DATA",19950329,0655,32.2,40.7,43.7,46.7,61.6,60.3,
46.7,45.4,51.4,59.9,52.2,64.2

"FP_OCCUPANCY","CPU_DATA",19950329,0755,72.7,74.7,71.4,71.4,73.1,66.7,
60.3,67.1,50.5,52.2,64.2,52.6

"FP_OCCUPANCY","CPU_DATA",19950329,0855,65.0,68.0,62.5,66.3,63.3,58.6,
60.7,69.3,65.9,59.9,51.8,78.2

"FP_OCCUPANCY","CPU_DATA",19950329,0955,70.1,

74.0,82.5,78.7,79.1,79.5,
73.5 68.0,65.0,54.3,53.1,54.8
"DBP_OCCUPANCY","CPU_DATA",19950328,1055,42.7,28.6,32.5,43.1,44.3,45.5,
37.6,51.4,36.9,40.4,36.5,29.0
"DBP_OCCUPANCY","CPU_DATA",19950328,1155,28.2,22.0,25.5,34.1,29.4,38.4,
39.6,40.0,56.1,42.7,44.3,39.2
"DBP_OCCUPANCY","CPU_DATA",19950328,1255,38.4,36.1,33.3,55.3,43.9,36.5,
27.8,31.4,33.3,27.5,35.3,27.8
"DBP_OCCUPANCY","CPU_DATA",19950328,1355,35.7,32.5,31.4,26.3,31.4,36.5,
26.7,24.7,32.5,33.3,32.9,29.8
"DBP_OCCUPANCY","CPU_DATA",19950328,1455,33.7,36.5,37.3,33.3,35.7,29.0,

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-96
17.3,23.9,32.5,31.8,21.6,29.0

"DBP_OCCUPANCY","CPU_DATA",19950328,1555,29.0,24.7,29.4,31.0,27.8,20.4,
18.8,22.7,12.5,19.6,15.7,15.7

"DBP_OCCUPANCY","CPU_DATA",19950328,1655,25.5,23.9,34.5,37.3,30.2,9.8,
12.5,12.9,7.8,8.2,11.0,10.6

"DBP_OCCUPANCY","CPU_DATA",19950328,1755,15.7,7.8,5.1,6.3,8.2,7.8,7.1,
6.7,3.1,4.7,3.1,2.7

"DBP_OCCUPANCY","CPU_DATA",19950328,1855,2.4,3.1,3.1,10.2,51.4,46.3,44.7,
44.7,47.8,43.9,50.6,55.7

"DBP_OCCUPANCY","CPU_DATA",19950328,1955,50.6,51.4,54.9,54.9,42.4,40.0,
40.0,40.8,43.1,42.7,42.0,42.7

"DBP_OCCUPANCY","CPU_DATA",19950328,2055,43.1,42.7,44.7,45.1,42.4,29.0,
29.0,28.6,28.2,31.0,29.8,29.4

"DBP_OCCUPANCY","CPU_DATA",19950328,2155,29.8,31.8,47.1,83.1,97.6,91.0,
87.1,97.3,94.9,95.3,86.3,80.8

"DBP_OCCUPANCY","CPU_DATA",19950328,2255,77.6,80.8,8,2.4,82.0,85.5,92.2,
94.1,93.7,91.8,92.2,84.7,86.7

"DBP_OCCUPANCY","CPU_DATA",19950328,2355,58.4,23.1,7.1,4.3,4.7,6.3,7.1,
6.7,7.8,6.7,5.1,1.2

"DBP_OCCUPANCY","CPU_DATA",19950329,0055,1.6,1.6,0.8,1.6,0.4,0.4,0.8,1.6,
2.0,0.4,1.2,0.4

"DBP_OCCUPANCY","CPU_DATA",19950329,0155,0.4,2.4,2.0,0.4,0.4,1.6,0.8,1.6,
1.2,0.4,0.4,0.8

"DBP_OCCUPANCY","CPU_DATA",19950329,0255,0.4,1.6,0.8,1.2,1.2,0.4,1.2,1.6,
0.4,0.8,0.8,0.8

"DBP_OCCUPANCY","CPU_DATA",19950329,0355,1.6,2.4,0.8,1.2,1.6,0.8,0.8,2.0,
2.0,0.4,1.2,1.6

"DBP_OCCUPANCY","CPU_DATA",19950329,0455,1.6,3.9,3.1,1.2,3.1,3.1,2.4,2.7,
3.1,3.1,5.9,3.9

"DBP_OCCUPANCY","CPU_DATA",19950329,0555,7.1,9.8,13.7,9.4,7.8,9.4,12.5,
16.9,23.5,16.1,14.9,18.0

"DBP_OCCUPANCY","CPU_DATA",19950329,0655,20.0,30.6,34.1,36.1,54.1,51.4,
39.2,40.4,39.6,54.5,45.9,52.9

"DBP_OCCUPANCY","CPU_DATA",19950329,0755,66.7,65.9,63.1,58.8,60.0,51.0,
54.5,53.3,38.0,43.9,48.2,38.8

"DBP_OCCUPANCY","CPU_DATA",19950329,0855,56.9,51.8,48.6,54.1,43.9,43.1,
48.6,54.9,56.9,37.3,50.6,65.1

"DBP_OCCUPANCY","CPU_DATA",19950329,0955,56.9,70.2,70.6,69.4,71.8,75.3,
58.0,55.7,45.1,38.8,40.0,44.7

The following command retrieves the INTUITY AUDIX Systems’ performance data
for February 26, 1999, and writes output to a file named perfdata.
getperf -D 022699 -r l-r5.0 > perfdata

RETURN

The following data is written to the file for the INTUITY AUDIX System:
"MACHINE_NAME","VEX_ID","drintuit"
"TIME_OF_DAY","TOD",19990226,0000
"CPU_OCCUPANCY","CPU_DATA",9,3,3,4,3,2,2,4,2,1,3,3
"CPU_OCCUPANCY","WIO_DATA",12,4,3,1,1,0,1,1,1,0,1,2
"CPU_OCCUPANCY","IDLE_DATA",79,93,94,95,96,98,97,95,97,98,97,94
"CPU_OCCUPANCY","PAGE_SCANS",0,0,0,0,0,0,0,0,0,0,0,0
"CPU_OCCUPANCY", "KERNEL_MEM", 0.088
"LAN_DATA","PKTS_SENT",62318
"LAN_DATA","PKTS_RCVD",101889
"LAN_DATA","BYTES_SENT",26622900
"LAN_DATA","BYTES_RCVD",30172117
"LAN_DATA","PKTS_RXMT",7

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-97
"PF_SPCH_PLY_VOIC","STAT",0,11,7,29,1
"PF_SPCH_REC_VOIC","STAT",0,0,0,0,0
"PF_SPCH_SAY_VOIC","STAT",11,11,1,11,1
"PF_MWI_ON_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_MWI_OFF_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_MWI_ON_STATS","STAT",0,0,0,0,0
"PF_MWI_OFF_STATS","STAT",0,0,0,0,0
"PF_GUEST_CONNECT_PEG","PEG",0
"PF_LWC_CONNECT_PEG","PEG",0
"PF_TRANSFER_PEG","PEG",0
"PF_HELP_PEG","PEG",0
"PF_WAIT_PEG","PEG",0
"PF_TOKEN_PEG","PEG",0
"PF_DA_TOKEN_PEG","PEG",0
"PF_EXT_ADDR_PEG","PEG",0
"PF_NAME_ADDR_PEG","PEG",0
"PF_LIST_ADDR_PEG","PEG",0
"PF_SKIPCAT_PEG","PEG",0
"PF_SABER_START_PEG","PEG",0
"PF_SABER_START_FAILED_PEG","PEG",0
"PF_SABER_AQUIRE_PEG","PEG",0
"PF_SABER_AQUIRE_FAILED_PEG","PEG",0
"PF_SABER_RETURN_ADDR_PEG","PEG",0
"PF_SABER_RETURN_TRF_PEG","PEG",0
"PF_SABER_DELETE_PEG","PEG",0
"PF_SABER_REJECT_PEG","PEG",0
"PF_SABER_MULTIPLE_PEG","PEG",0
"PF_SABER_TURN_ON_PEG","PEG",0
"PF_SABER_TURN_OFF_PEG","PEG",0
"PF_FWD_PEG","PEG",0
"PF_VM_REPLY_PEG","PEG",0
"PF_XFER_REPLY_PEG","PEG",0
"PF_FILE_CAB_PEG","PEG",0
"PF_CREATE_LIST_PEG","PEG",0
"PF_INVCOM_PEG","PEG",0
"PF_FMBOX_PEG","PEG",0
"PF_VM_CREATE_MSG_PEG","PEG",0
"PF_CA_CREATE_VOICE_PEG","PEG",0
"PF_CA_CREATE_FAX_PEG","PEG",0
"PF_VM_CREATE_VOICE_PEG","PEG",0
"PF_VM_CREATE_FAX_PEG","PEG",0
"PF_PRINT_SAME_CALL_PEG","PEG",0
"PF_PRINT_3PTY_PEG","PEG",0
"PF_TTF_COVER_PEG","PEG",0
"PF_TTF_BODIES_PEG","PEG",0
"PF_TTS_ANNT_PEG","PEG",1
"PF_TTS_NAMES_PEG","PEG",0
"PF_TTS_BODIES_PEG","PEG",0
"PF_TTS_FAILS_PEG","PEG",0
"PF_RECOG_DESIRED_PEG","PEG",0
"PF_RECOG_START_PEG","PEG",0
"PF_RECOG_USED_PEG","PEG",0
"PF_RECOG_FAILS_PEG","PEG",0
"PF_CA_VOICE_LGTH_STATS","STAT",0,0,0,0,0
"PF_CA_VOICE_LGTH_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_VM_VOICE_LGTH_STATS","STAT",0,0,0,0,0
"PF_VM_VOICE_LGTH_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_CA_FAX_LGTH_STATS","STAT",0,0,0,0,0
"PF_CA_FAX_LGTH_0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_VM_FAX_LGTH_STATS","STAT",0,0,0,0,0

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-98
"PF_VM_FAX_LGTH_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_TTF_BYTES_STATS","STAT",0,0,0,0,0
"PF_TTF_BYTES_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_TTS_SESS_STATS","STAT",1,1,1,1,1
"PF_TTS_SESS_HIST","HIST",0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_RCP_STATS","STAT",0,0,0,0,0
"PF_RCP_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_BC_UPD_STATS","STAT",0,0,0,0,0
"PF_VM_MSG_LGTH_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_VM_MSG_LGTH_STATS","STAT",0,0,0,0,0
"PF_CA_MSG_LGTH_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_CA_MSG_LGTH_STATS","STAT",0,0,0,0,0
"PF_COM_ACT_PEG","PEG",0
"PF_SIM_ACT_PEG","PEG",1
"PF_GA_ACT_PEG","PEG",0
"PF_SOM_ACT_PEG","PEG",0
"PF_SA_ACT_PEG","PEG",0
"PF_OC_ACT_PEG","PEG",0
"PF_AMS_ACT_PEG","PEG",0
"PF_SY_ACT_PEG","PEG",0
"PF_DD_STATS","STAT",0,0,0,0,0
"PF_DD_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_DD_CDD_STATS","STAT",0,0,0,0,0
"PF_DD_CDD_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_SABER_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_SABER_SESS_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
"PF_DEL_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_UNDEL_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_Q_MAIL_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_NVBACK_HIST","HIST",0,1,0,0,0,0,0,0,0,0,0,0
"PF_MSGAPP_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_IVR_GET_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_IVR_PUT_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_FWD_MSGAPP_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_REPLY_MSGAPP_HIST","HIST",0,0,0,0,0,0,0,0,0,0,0,0
"PF_DEL_STATS","STAT",0,0,0,0,0
"PF_SABER_STATS","STAT",0,0,0,0,0
"PF_SABER_SESS_STATS","STAT",0,0,0,0,0
"PF_UNDEL_STATS","STAT",0,0,0,0,0
"PF_QMAIL_STATS","STAT",0,0,0,0,0
"PF_N_VBACK_STATS","STAT",16,16,1,16,2
"PF_MSGAPP_STATS","STAT",0,0,0,0,0
"PF_IVR_GET_STATS","STAT",0,0,0,0,0
"PF_IVR_PUT_STATS","STAT",0,0,0,0,0
"PF_FWD_MSGAPP_STATS","STAT",0,0,0,0,0
"PF_REPLY_MSGAPP_STATS","STAT",0,0,0,0,0
"API_PEG_get_comp_binary","PEG",0
"API_PEG_get_comp_fax","PEG",0
"API_PEG_get_comp_text","PEG",0
"API_PEG_get_comp_voice","PEG",0
"API_PEG_put_comp_binary","PEG",0
"API_PEG_put_comp_fax","PEG",0
"API_PEG_put_comp_text","PEG",0
"API_PEG_put_comp_voice","PEG",0
"API_PEG_register_event_notification","PEG",8
"API_PEG_sync_bodies_in","PEG",0
"API_PEG_sync_headers_in","PEG",0
"API_PEG_ts_bodies_out","PEG",0
"API_PEG_ts_headers_out","PEG",0
"API_STATS_add_remote_subscriber","STAT",0,0,0,0,0

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-99
"API_STATS_add_subscriber","STAT",0,0,0,0,0
"API_STATS_add_to_list","STAT",0,0,0,0,0
"API_STATS_admin_login","STAT",0,0,0,0,0
"API_STATS_change_password","STAT",0,0,0,0,0
"API_STATS_change_play_position","STAT",0,0,0,0,0
"API_STATS_change_play_speed","STAT",0,0,0,0,0
"API_STATS_change_play_volume","STAT",0,0,0,0,0
"API_STATS_check_new_messages","STAT",0,0,0,0,0
"API_STATS_connect","STAT",0,0,77,0,0
"API_STATS_connect_voice_port","STAT",0,0,0,0,0
"API_STATS_convert_format","STAT",0,0,0,0,0
"API_STATS_create_list","STAT",0,0,0,0,0
"API_STATS_delete_greeting","STAT",0,0,0,0,0
"API_STATS_delete_list","STAT",0,1,58,21,0
"API_STATS_delete_message","STAT",0,1,58,2,0
"API_STATS_delete_subscriber","STAT",0,0,0,0,0
"API_STATS_deliver_ca_message","STAT",0,0,0,0,0
"API_STATS_deliver_message","STAT",0,0,0,0,0
"API_STATS_disconnect","STAT",0,0,77,0,0
"API_STATS_disconnect_voice_port","STAT",0,0,1,0,0
"API_STATS_get_admin_data","STAT",0,1,58,3,0
"API_STATS_get_greeting_map","STAT",0,0,0,0,0
"API_STATS_get_list","STAT",0,0,0,0,0
"API_STATS_get_list_ids","STAT",0,0,0,0,0
"API_STATS_get_mailbox_status","STAT",0,3,72,65,0
"API_STATS_get_message_component","STAT",0,0,0,0,0
"API_STATS_get_message_header","STAT",0,0,0,0,0
"API_STATS_get_message_header_block","STAT",0,0,0,0,0
"API_STATS_get_message_header_block_sums","STAT",0,5,169,152,0
"API_STATS_get_message_property","STAT",0,0,0,0,0
"API_STATS_get_message_property_block","STAT",0,0,0,0,0
"API_STATS_get_outcall_data","STAT",0,0,0,0,0
"API_STATS_get_property","STAT",0,0,0,0,0
"API_STATS_get_session_data","STAT",0,0,0,0,0
"API_STATS_get_subscriber_directory_block","STAT",0,0,0,0,0
"API_STATS_get_subscriber_directory_entry","STAT",0,0,0,0,0
"API_STATS_get_subscriber_id_by_address","STAT",0,0,0,0,0
"API_STATS_get_subscriber_id_by_name","STAT",0,0,0,0,0
"API_STATS_get_subscriber_id_by_number","STAT",0,0,0,0,0
"API_STATS_get_subscriber_id_by_ttname","STAT",0,0,0,0,0
"API_STATS_get_usage_data","STAT",0,0,0,0,0
"API_STATS_get_voice_port_status","STAT",0,0,6,0,0
"API_STATS_install_greeting","STAT",0,0,0,0,0
"API_STATS_install_message_component","STAT",0,0,0,0,0
"API_STATS_install_message_properties","STAT",0,0,0,0,0
"API_STATS_install_message_property","STAT",0,0,0,0,0
"API_STATS_install_name","STAT",0,0,0,0,0
"API_STATS_logout","STAT",0,8,147,76,0
"API_STATS_play_message","STAT",0,0,0,0,0
"API_STATS_play_prompt","STAT",0,0,0,0,0
"API_STATS_print_message","STAT",0,0,0,0,0
"API_STATS_put_admin_data","STAT",0,0,0,0,0
"API_STATS_put_annotation","STAT",0,0,0,0,0
"API_STATS_put_greeting_map","STAT",0,0,0,0,0
"API_STATS_put_message_component","STAT",0,0,0,0,0
"API_STATS_put_message_property","STAT",0,0,0,0,0
"API_STATS_put_outcall_data","STAT",0,0,0,0,0
"API_STATS_put_prompt","STAT",0,0,0,0,0
"API_STATS_register_event_notification","STAT",0,13,19,47,1
"API_STATS_remove_from_list","STAT",0,0,0,0,0

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-100
"API_STATS_retrieve_greeting","STAT",0,0,0,0,0
"API_STATS_retrieve_name","STAT",0,0,0,0,0
"API_STATS_server_deliver_message","STAT",0,0,0,0,0
"API_STATS_server_lock_mailbox","STAT",1,6,97,131,0
"API_STATS_server_log_error","STAT",0,0,0,0,0
"API_STATS_server_login","STAT",1,18,131,234,3
"API_STATS_server_read_queue","STAT",0,1,58,25,0
"API_STATS_server_sync_message","STAT",0,0,0,0,0
"API_STATS_server_unlock_mailbox","STAT",1,8,97,168,0
"API_STATS_server_update_queue","STAT",0,0,0,0,0
"API_STATS_start_record","STAT",0,0,0,0,0
"API_STATS_stop_play","STAT",0,0,0,0,0
"API_STATS_stop_record","STAT",0,0,0,0,0
"API_STATS_subscriber_login","STAT",1,32,16,68,10
"API_STATS_transfer","STAT",0,0,0,0,0
"API_STATS_update_message_status","STAT",0,0,0,0,0
"API_STATS_update_subscriber","STAT",0,0,0,0,0
"API_STATS_SERVER_SESSION","STAT",0,1,131,9,9
"API_STATS_SESSION","STAT",300,320,16,4826,1456006
"API_STATS_TOTAL_connect_voice_port","STAT",0,0,0,0,0
"API_STATS_TOTAL_get_message_component","STAT",0,0,0,0,0
"API_STATS_TOTAL_get_message_property","STAT",0,0,0,0,0
"API_STATS_TOTAL_put_message_component","STAT",0,0,0,0,0
"API_STATS_TOTAL_put_message_property","STAT",0,0,0,0,0
"API_STATS_TOTAL_put_prompt","STAT",0,0,0,0,0
"API_STATS_TOTAL_convert_format","STAT",0,0,0,0,0

Data Types
The getperf command collects the following types of data:
■

Peg counts

■

Statistics and histograms

■

Processor occupancy

■

LAN Traffic

Entering a single getperf command retrieves all types of data. You can direct the
data into an output file in a format that is readable by dBASE III PLUS.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-101

Performance Data to be Collected
This section defines the data that is collected.
■

Pegs
The peg counts have a type PEG and have a single data value. On an
INTUITY or DEFINITY AUDIX System, peg counts are created and saved on
an hourly basis, then reset for the next hour. When an R1 AUDIX System is
rebooted, the system initializes the peg values to zero and continuously
increments the peg values. To determine the number of occurrences of a
particular peg during an interval of time on an R1 AUDIX System, the peg
count must be read at the beginning and at the end of the interval.
Each peg count is described below with the data label in parentheses:
— Guest Connections (PF_GUEST_CONNECT_PEG) is the number of
successful guest logins.
— Leave Word Calling Connections (PF_LWC_CONNECT_PEG) is the
number of leave word calling messages created.
— Call Transfer Out of AUDIX (PF_TRANSFER_PEG) is the number of
transfers out of the DEFINITY AUDIX or R1 AUDIX Systems
performed using the *T, *0, or 10 to reply to a message.
— Entry of *H (PF_HELP_PEG) is the number of times *H is used.
— Entry of *W (PF_WAIT_PEG) is the number of times *W (wait) is
used.
— Tokens (PF_TOKEN_PEG) is the number of touch tone commands
correctly entered.
— Dial Ahead Tokens (PF_DA_TOKEN_PEG) is the number of touch
tone commands correctly entered before the announcement
requesting the command begins to play.
— Entry Not Understood (PF_INVCOM_PEG) is the number of times
the Invalid Entry announcement (on the DEFINITY AUDIX System)
or the Entry Not Understood announcement (on the R1 AUDIX
System) is played.
(The next eight pegs are the number of times each is entered on the
main activity menu:)
— Create Outgoing Mail (PF_COMM_ACT_PEG)
— Scan Incoming Mail (PF_SIM_ACT_PEG)
— Greeting Administration (PF_GA_ACT_PEG)
— Scan Outgoing Mailbox (PF_SOM_ACT_PEG)
— Subscriber Administration (PF_SA_ACT_PEG)
— Outcalling Administration (PF_OC_ACT_PEG)

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-102

— Automatic Message Scan (PF_AMS_ACT_PEG)
— System Administration (PF_SY_ACT_PEG)
— Address Entered By Extension (PF_EXT_ADDR_PEG) is the number
of times a message is addressed using the subscriber’s extension.
— Address Entered By Name (PF_NAME_ADDR_PEG) is the number
of times a message is addressed using the subscriber’s name.
— Addresses Entered By List (PF_LIST_ADDR_PEG) is the number of
times a list is used to address a message.
— Categories Skipped (PF_SKIPCAT_PEG) is the number of times *#
is entered to skip to the next category.
— SABER Reservations (PF_SABER_AQUIRE_PEG) is the number of
times the recognizer was reserved
— SABER Reservation Failures (PF_SABER_AQUIRE_FAILED_PEG) is
the number of times the recognizer failed to reserve
— SABER Recognitions Started (PF_SABER_START_PEG) is the
number of times the recognizer was started
— SABER Recognition Failures (PF_SABER_START_FAILED_PEG) is
the number of times the recognizer failed to start
— Addresses Entered by Spoken Name (PF_SABER_RETURN_
ADDR_PEG) is the number of times callers spoke a name during
message addressing
— Transfers Using Spoken Name (PF_SABER_RETURN_TRF_PEG) is
the number of times callers spoke a name during call transfer
— Extensions Deleted (PF_SABER_DELETE_PEG) is the number of
times callers deleted an extension after what appeared to be a
spoken name rather than a name entered by the telephone keypad
— SABER Callers Rejected (PF_SABER_REJECT_PEG) is the number
of times SABER rejected callers
— Multiple Extensions Returned by SABER (PF_SABER_MULTIPLE_
PEG) is the number of times SABER returned more than one
extension
— SABER Turned On (PF_SABER_TURN_ON_PEG) is the number of
times callers explicitly turned SABER on (through *M0)
— SABER Turned Off (PF_SABER_TURN_OFF_PEG) is the number of
times callers explicitly turned SABER off (through *M0)
— Messages Forwarded (PF_FWD_PEG) is the number of times 12 or
13 is entered to forward an incoming message.
— Messages Replied To By Voice Mail (PF_VM_REPLY_PEG) is the
number of times 11 is entered to reply to a message.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-103

— Messages Replied To By Calling Sender (PF_XFER_REPLY_PEG) is
the number of times 10 is entered to call the sender of an incoming
message.
— Lists Created (PF_CREATE_LIST_PEG) is the number of times a 1 is
entered to create a list.
— Deltas Sent (PF_ND_SENT_PEG) is the number of networking
deltas (administrative updates) sent to another AUDIX System.
— Deltas Received (PF_ND_RECD_PEG) is the number of networking
deltas (administrative updates) received from another AUDIX
System.
— Full Mailbox (PF_FMBOX_PEG) is a count of all call answer
sessions where the subscriber’s mailbox is full.
— File Cabinet (PF_FILE_CAB_PEG) is a count of messages stored in
the file cabinet.
— Messages sent (PF_RM_SENT_PEG) is a count of networked
messages sent.
— Messages received (PF_RM_RECD_PEG) is a count of networked
messages received.
— Subscribers sent (PF_SBS_SENT_PEG) is the number of
subscribers sent during full update sessions.
— Subscribers received (PF_SBS_RECD_PEG) is the number of
subscribers received during full update sessions.
— Remote names (PF_VS_SENT_PEG) is the number of remote names
sent..
— Remote names (PF_VS_RECD_PEG) is the number of remote
names received.
— Message transmissions (PF_XMT_SENT_PEG) is a count of
message transmissions to remote systems.
— Message transmissions (PF_XMT_RECD_PEG) is a count of
message transmissions from remote systems.
■

Statistics and Histograms
There are two types of statistics and two types of histograms included in
the performance data. The statistics types for DEFINITY AUDIX are
"PUDSTAT" and "PTSTAT".
■

INTUITY also uses PUDSTAT and PTSTAT, but both are simply
represented by STAT.

■

The data for both of these types is identical and is in the following
format:

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-104

INTUITY and DEFINITY AUDIX Systems:
"label","type",min,max,pegs,total,sum-of-squares
R1 AUDIX System:
"label","type",max,min,pegs,total,unused
where "max" is the max. value recorded for the particular
event
"min" is the minimum value recorded for the particular event
"pegs" is the number of occurrences of the particular event
"total" is the total of all of the measured peg values
"sum-of-squares" is the sum of squares data
"unused" is not used at the present time.
The average value is equal to total divided by pegs. All five values are
initialized to zero each hour on a INTUITY or DEFINITY AUDIX System and
at reboot on an R1 AUDIX System. The average for a particular interval of
time can be determined by reading the data at the beginning and at the
end of the interval and taking the difference of the pegs and total values
before dividing. Min indicates the minimum value and max indicates the
maximum value during the interval of time.
■

The histogram types for the DEFINITY AUDIX System are
PONESECOND and PDBLBLANK.

■

INTUITY also uses PONESECOND and PDBLBLANK, but both are
simply represented by HIST.

The data for histograms are basically a set of numbers, one of which is
incremented each time an event occurs. The number that is incremented
depends on the value of the particular event. For INTUITY and DEFINITY
AUDIX Systems, each histogram includes two additional numbers: the first
number represents underflow (values less than those in the smallest cell),
the last number represents overflow (values greater than those in the
largest cell).
INTUITY and DEFINITY AUDIX Systems:
The DEFINITY AUDIX System histogram type called "PONESECOND"
(HIST for INTUITY) has 10 data entries. Each number is the number for
recorded events that had a duration within a one second window. The first
data entry is the number of recorded events that took less than one
second. The second data entry is the number of events that took between
one and two seconds. Each successive data entry represents each
successive one second window. The tenth data entry is the number of
events that took greater than nine seconds. Therefore the data format for
the R1 AUDIX System is:
"label","PONESECOND",0-1,1-2,...,8-9,>9

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-105

The INTUITY and DEFINITY AUDIX System uses the following format:
"label","PONESECOND",underflow(unused),0-1,1-2,...,8-9,
9-10,overflow (>10)
The data is initialized to zero at the beginning of each hour on INTUITY and
DEFINITY AUDIX System, and on a reboot on an R1 AUDIX System, and
each is incremented continuously.
The DEFINITY AUDIX System histogram type "PDBLBLANK" (HIST for
INTUITY) has 20 data entries that represent a value for a particular event.
The value of each cell is described in the section about the particular
statistic.
The sets of statistics and histograms available are described below with
the label and type in parentheses:
For the DEFINITY AUDIX System:
— Recipients Per Message (PF_RCP_STATS,PUDSTAT) are statistics
on the total number of recipients for each voice mail message sent
to 2 or more recipients.
— Recipients Per Message (PF_RCP_HIST,PDBLBLANK) is a
histogram of the number of recipients for each voice mail message
sent to 2 or more recipients.
This histogram indicates the number of recipients each time a list is
used. The first data entry represents lists of 2 through 9 recipients.
The second entry represents 10 through 19 recipients and so on.
The 20th and last data entry represents the number of times a list is
used with 190 through 250 recipients.
— Members Per List Created (PF_CLMS_STATS,PUDSTAT) are
statistics on the number of members in each list that is created.
(The next eight statistics are statistics on the time spent in each of
the eight activities from the main activity menu:)
— Create Outgoing Mail (PF_COM_STATS,PTSTAT)
— Scan Incoming Mail (PF_SIM_STATS,PTSTAT)
— Greeting Administration (PF_GA_STATS,PTSTAT)
— Scan Outgoing Mailbox (PF_SOM_STATS,PTSTAT)
— Subscriber Administration (PF_SA_STATS,PTSTAT)
— Outcalling Administration (PF_OC_STATS,PTSTAT)
— Automatic Message Scan (PF_AMS_STATS,PTSTAT)
— System Administration (PF_SY_STATS,PTSTAT)
— Message Deleted Interval (PF_DEL_STATS,PTSTAT) are statistics on
the time from a user pressing *D to delete a message until the
announcement deleted begins to play out.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-106

— Message Deleted Interval (PF_DEL_HIST,PONESECOND) is a
histogram of the time from a user pressing *D to delete a message
until the announcement deleted begins to play out.
— Queue-Mail Interval (PF_Q_MAIL_STATS,PTSTAT) are statistics on
the time from when a user sending a message gives the final
instructions to deliver a message until the announcement
requesting the next operation begins to play out.
— Queue-Mail Interval (PF_Q_MAIL_HIST,PONESECOND) is a
histogram of the time from when a user sending a message gives
the final instructions to deliver a message until the announcement
requesting the next operation begins to play out.
— Name Voiceback Interval (PF_NVBACK_STATS, PTSTAT) are
statistics on the time between entering the # after entering a
password during a successful login until the subscriber’s name
begins to play out.
— Name Voiceback Interval (PF_NVBACK_HIST, PONESECOND) is a
histogram of the time between entering the # after entering a
password during a successful login until the subscriber’s name
begins to play out.
— Message Recording Time (PF_MRCRD_STATS, PTSTAT) are
statistics on the time spent recording messages.
— Broadcast Update (PF_BC_UPD_STATS, PTSTAT) are statistics on
the time spent to update all Message Waiting Lamps when a
broadcast message is sent.
— Message Waiting Indicator On (PF_MWI_ON_STATS, PUDSTAT) are
statistics on the time it takes to turn on a message waiting indicator.
— Message Waiting Indicator On (PF_MWI_ON_HIST, PDBLBLANK)
is a histogram of the time it takes to turn on a message waiting
indicator.
This histogram is similar to a PONESECOND histogram, except that
there are 20 cells (plus underflow and overflow) instead of 10 cells.
— Message Waiting Indicator Off (PF_MWI_OFF_STATS, PUDSTAT)
are statistics on the time it takes to turn off a message waiting
indicator.
— Message Waiting Indicator Off (PF_MWI_OFF_HIST, PDBLBLANK)
is a histogram of the time it takes to turn off a message waiting
indicator.
This histogram is similar to a PONESECOND histogram, except that
there are 20 cells (plus underflow and overflow) instead of 10 cells.
— IMAPI statistics (prefix is API_STATS) are statistics on the time it
takes to execute each of the IMAPI function cells.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-107

— Network Message Delivery Time (PF_DD_STATS) are statistics on
the time to deliver a networked message.
— Network Message Delivery Time (PF_DD_HIST) is a histogram of
the time it takes to deliver a networked message.
The histogram has 20 buckets that are organized according to delivery delay
intervals as shown below:
Buckets 1 -12: 5 minute intervals, 0->5 min, 5+-> min, ...55+->60 min
Buckets 13, 14: 15 minute intervals, 60+->75 min, 75+->90 min
Bucket 15: 30 minute interval: 90+->120 min
Bucket 16: 1 hour interval: 2+ hrs -> 3 hrs
Bucket 17: 2 hour interval: 3+ hrs -> 5 hrs
Bucket 18: 4 hour interval: 5+ hrs -> 9 hrs
Bucket 19: 16 hour interval: 9+ hrs -> 25 hrs
Bucket 20: over 25 hours
— (PF_SABER_HIST) a histogram of the time between turning SABER
on and SABER returning a result
— (PF_SABER_SESS_HIST) a histogram of the total time a SABER
session is held
— (PF_SABER_STATS) statistics on the time between turning SABER
on and SABER returning a result
— (PF_SABER_SESS_STATS) statistics on total amount of time a
SABER session is held
— (PF_MSGAPP_STATS) statistics on the time between pressing "#"
to approve a message and hearing the next announcement.
— (PF_MSGAPP_HIST) a histogram of the time between pressing "#"
to approve a message and hearing the next announcement.
— (PF_FWD_MSGAPP_STATS) statistics on the time between pressing
"#" to approve a forwarded and hearing the next announcement.
— (PF_FWD_MSGAPP_HIST) a histogram of the time between
pressing "#" to approve a message and hearing the next
announcement.
— (PF_REPLY_MSGAPP_STATS) statistics on the time between
pressing "#" to approve a message reply and hearing the next
announcement.
— (PF_REPLY _MSGAPP_HIST) a histogram of the time between
pressing "#" to approve a message and hearing the next
announcement.
— (PF_UNDEL_STATS) statistics on the time from a user pressing **u
until the announcement that the message was restored is played
out.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-108

— (PF_UNDEL_HIST) a histogram of the time between pressing "#" to
approve a message and hearing the next announcement.
— (PF_VM_MSG_LGTH_STATS) statistics on the length of voice mail
messages.
— (PF_VM_MSG_LGTH_HIST) a historogram of the length of voice
mail messages. Each bucket represents 30 seconds.
— (PF_CA_MSG_LGTH_STATS) statistics on the length of Call Answer
messages.
— (PF_CA_MSG_LGTH_HIST) a histogram of the length of Call
Answer messages. Each bucket represents 30 seconds.
■

Processor Occupancy
Processor occupancy data measures the average occupancy over a five
minute interval. For the Feature Processor (FP), Voice Session Processor
(VSP), and the Data Base Processor (DBP), 24 hours of occupancy data is
available for the 24 hours before that data is retrieved. For the
Multi-Function Board (MFB) and for the INTUITY AUDIX system, eight days
of occupancy data are available just as they are for all other performance
statistics.
The type for all occupancy measurements is "CPU_DATA". The labels for
the occupancy measurements are "FP_OCCUPANCY",
"VSP_OCCUPANCY", and "DBP_OCCUPANCY" for the R1 AUDIX
System and "MFB_OCCUPANCY" for the DEFINITY AUDIX System and
"CPU_OCCUPANCY" for INTUITY. For the FP, VSP, and DBP, each line
contains one hour’s worth of data beginning at the date and time shown.
Therefore, there are a total of 24 lines of data for the FP, VSP, and DBP.
For INTUITY and DEFINITY AUDIX System, each line contains one hour’s
worth of data beginning at the date and time shown; there is one line for
every hour requested.
ADAP collects the following CPU_OCCUPANCY data for an INTUITY
system:
— (IDLE_DATA) system idle time (percent)
— (CPU_DATA) sum of user and system CPU occupancy (percent)
— (WIO_DATA) wait I/O time (percent)
— (PAGE_SCAN) page scans per second
— (KERNEL_MEM) dynamic kernel memory allocated (MB/hour)
The system registers an event in the event log whenever one of the above
measurements is outside the recommended range. In addition, a warning
alarm is generated whenever the system idle time is too low (less than
10% for 20 minutes or more during the last hour).
The only other data that appear in the output file for a INTUITY or DEFINITY
AUDIX System after using the getperf command is one line indicating the
date and time of day associated with the data.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-109

The only other data that appear in the output file for the R1 AUDIX System
after using the getperf command is one line indicating the date and time
of day when the data are retrieved and one line indicating the time since
the system last restarted in days, hours, and minutes.
■

LAN Traffic Data
The following data is collected about the LAN traffic on the INTUITY system:
— (LAN_DATA, PKTS_SENT) number of packets sent by the INTUITY
system to the LAN interface since the INTUITY was last booted
— (LAN_DATA, PKTS_RCVD) number of packets received by the
INTUITY system from the LAN interface since the INTUITY was last
booted
— (LAN_DATA, BYTES_SENT) number of bytes sent by the INTUITY
system to the LAN interface since the INTUITY was last booted
— (LAN_DATA, BYTES_RCV) number of bytes received by the INTUITY
system from the LAN interface since the INTUITY was last booted
— (LAN_DATA, PKTS_RXMT) number of packets retransmitted from
the INTUITY system to the LAN interface since the INTUITY was last
booted

Data Collection
For the INTUITY and DEFINITY AUDIX Systems, the getperf command writes the
time associated with the data to be retrieved. It then issues an appropriate
number of commands to retrieve the performance file for the date and times
specified.
For R1 AUDIX Systems, the getperf command first reads the AUDIX System
clock and records the current date and time of day. It then issues an appropriate
number of commands to retrieve the performance data.

Output Format for Each Data Type
The following list provides an example for each type of performance data:
■

Pegs
"PF_GUEST_CONNECT_PEG","PEG",5

■

Statistics
"PF_CLMS_STATS","PUDSTAT",17,1,45,269,0

■

Histograms
"PF_RCP_HIST","PDBLBLANK",590,102,20,3,7,10,3,2,6,9,2,0,0,0,0,0,0,
0,0,0

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getperf

12-110
■

MFB Occupancy
"MFB_OCCUPANCY","CPU_DATA",24.1,19.4,18.9,15.9,22.3,26.2,13.0,
14.72,16.4,10.8,11.3

■

FP/VSP Occupancy
"FP_OCCUPANCY","CPU_DATA",19890809,1700,39.0,36.0,33.0,28.7,
26.2, 29.6,26.2, 20.2,etc.

■

DBP Occupancy
"DBP_OCCUPANCY","CPU_DATA",19940809,1730,50.6,31.0,47.5,36.5,
53.7,49.8,48.2,41.2,38.0,37.3,51.0,49.4

■

CPU Occupancy for the INTUITY AUDIX System
"CPU_OCCUPANCY","CPU_DATA",52,46,51,47,51,47,59,50,51,51,
50,49

For the DEFINITY AUDIX System:
The first element of the output file for a particular hour is the MFB board location.
"MFB_NUMBER","BOARD_NUM", embed
The next element of the output file is the date and time of day for the next set of
associated data.
"STARTING_TIME","TOD", yyyymmdd, hh00
The remainder of the output file lists the MFB occupancy first, followed by pegs,
followed by all statistics and histograms.
For R1 AUDIX Systems,
The first element of the output file is the current date and time of day, as read
using the system clock screen:
"TIME_OF_DAY","TOD", yyyymmdd, hhmm
The second element is the time since boot, computed using the value of "Perf_
ticks" in the FP data:
"TIME_SINCE_BOOT","PERF_TIME", ddd, hhmm
The remainder of the output file lists all pegs first, followed by all statistics and
histograms, followed by all occupancy data.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getralar

12-111

getralar

12

Get resolved alarm data

Syntax
getralar [-d mmddyy [-t hhmm]] [-c fault/alarm code] [-M y/n] [-m y/n]
[-W y/n] [-T resource-type [-L location]] [-n nnnn] [-u unit]
[-l level] [-p nn] [-r release] [-A application] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves all pages of the following screens for the search information that you specify:
■

INTUITY AUDIX Display Alarms

■

DEFINITY AUDIX Display Alarms

■

R1 AUDIX maintenance : resolved alarm : display

For the INTUITY and DEFINITY AUDIX Systems, ADAP updates the specification
fields of the Display Alarms screen while retrieving the data. For the R1 AUDIX
System, ADAP updates the maintenance : resolved alarm : specification screen
before retrieving the screen data. The voice mail system retains the values you
supply after the retrieval is completed.
If you omit the options and their qualifiers (for example, unit, level, and fault/alarm
code), then all resolved alarms from and including the specified date are
returned.
For complete lists of units, resource types and fault/alarm codes, see the
appropriate voice mail system maintenance manual.
No input is required. All resolved alarms retrieved are written to standard output.

-d

Date flag; must be followed by mmddyy. This flag is required for
R1 AUDIX systems. The default is to retrieve data for all dates.

mmddyy

Retrieves data starting at the month, day, and year indicated by
mmddyy. For example, if you enter 072294, the data starting on
July 22, 1994, is retrieved.

-t

Time of day flag; must be followed by hhmm. This flag is available
only if the -d flag is also specified. This flag is required for AUDIX
systems. The default is to retrieve all data starting at the specified
date.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getralar

12-112

hhmm

Retrieves errors from the specified hour and minute to the current
time. For example, if you enter 1512 at 6:00 p.m. (for retrieval on
the same day), the data from 3:12 p.m. to 6:00 p.m. is retrieved.
Midnight is represented by 0000.

-T

Resource type; flag must be followed with resource-type. This
argument is valid only for the INTUITY and DEFINITY AUDIX
systems.

resource
type

Retrieves alarms logged against the resource type that you
specify. See the appropriate voice mail system maintenance
manual for a list of resource types.

-L

Location flag; must be followed with location. This argument is
valid only for the INTUITY and DEFINITY AUDIX Systems.

location

Retrieves errors logged against resources at the specified
location. The -T resource-type argument also must be specified.
See the appropriate voice mail system forms reference manual for
the format of location.

-M

Major alarms; must be followed by either y or n. This argument is
valid only for the INTUITY and DEFINITY AUDIX systems. The
default is y.

y/n

Retrieves or does not retrieve major alarms.

-m

Minor alarms flag; must be followed by either a y or n. This
argument is valid only for the INTUITY and DEFINITY AUDIX
systems. The default is y.

y/n

Retrieves or does not retrieve minor alarms.

-W

Warning alarm flag; must be followed by either a y or n. This
argument is valid only for the INTUITY and DEFINITY AUDIX
systems. The default is y.

y/n

Retrieves or does not retrieve warning alarms.

-n

Number of alarm entries flag; must be followed by nnnn. This
argument is valid only for the INTUITY and DEFINITY AUDIX
systems.

nnnn

Retrieves the number (nnnn) of alarm entries that you specify. If
you don’t specify this flag or you use the word all, all alarm entries
that meet the specification criteria are returned.

-u

Hardware unit; flag must be followed by unit. This argument is
valid only for the R1 AUDIX System.

unit

Retrieves alarms logged against the hardware unit that you
specify. See the appropriate voice mail system maintenance
manual for a list of units.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getralar

12-113

-l

Severity level number; flag must be followed by level. This flag is
available only for R1 AUDIX systems.

level

Retrieves alarms logged with the severity level you specify (0 =
major, 1 = minor, and 2 = warning).

-c

Fault/alarm code number flag; must be followed by fault/alarm
code.

fault/alarm
code

Retrieves alarms logged with the specific fault code.

-A

Application flag; must be followed by application. This flag is only
available with the Intuity AUDIX System.

application

Retrieves only records logged against this application (module),
i.e. VM. See INTUITY AUDIX Platform Administration and
Maintenance for Release 3.0 585-310-557.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX System software. For DEFINITY
AUDIX Systems, the default is D-r3.2. For INTUITY AUDIX Systems,
the default is I-r5.0

-p

Number of alarm pages flag; must be followed by nn. This flag is
available only for AUDIX systems.

nn

Retrieves the number (nn) of alarm pages that you specify.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getralar

12-114

Errors
If no resolved alarms exist that fit the specified search, no output is written.

! CAUTION:
The following caution applies only to R1 AUDIX Systems:
If operators on the local maintenance terminal (LMT) and the local administration terminal (LAT) concurrently access the same screen information, output on either terminal could prematurely terminate or reflect other
undesirable changes.

Output Format
Output for the getralar command when communicating with DEFINITY and
INTUITY AUDIX systems is formatted as follows, with one record for each alarm.
FIELD
Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

resource type

C

10

D-r1.0+

I-r2.0+

2

location

C

11

D-r1.0+

I-r2.0+

3

alarm level

C

3

D-r1.0+

I-r2.0+

4

fault/alarm code

N

4

D-r1.0+

I-r2.0+

5

acknowledge

C

1

D-r1.0+

I-r2.0+

6

data alarmed

D

8

D-r1.0+

I-r2.0+

7

time alarmed

T

4

D-r1.0+

I-r2.0+

8

date resolved

D

8

D-r1.0+

I-r2.0+

9

time resolved

T

4

D-r1.0+

I-r2.0+

10

resolve reason

C

6

D-r1.0+

I-r2.0+

11

application

C

2

I-r2.0+

Output for the AUDIX getralar command when communicating with an R1 AUDIX
System is formatted as follows, with one record for each alarm

FIELD

VOICE MAIL VERSIONS

Field Name

Type

Max.
Width

R1
AUDIX
System

1

activated date

D

8

r1v2+

2

activated time

T

4

r1v2+

3

resolved date

D

8

r1v2+

4

resolved time

T

4

r1v2+

Seq.
No.

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getralar

12-115
FIELD

VOICE MAIL VERSIONS

Field Name

Type

Max.
Width

R1
AUDIX
System

5

fault

N

4

r1v2+

6

level

N

1

r1v2+

7

unit

N

3

r1v2+

8

device

N

2

r1v2+

Seq.
No.

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Example
The following command retrieves the DEFINITY AUDIX Display Alarms screen
data starting at midnight on October 14, 1994, writes a summary of the transfer
statistics to the screen, and writes output to a file named ralarms.
getralar -d 101494 -t 0000 -v > ralarms

RETURN

The following data is written to the file:
"ALARM_BD","01B07","MIN",0,"n",19941014,1231,19941014,
1253,"Reboot" NEWLINE
The file may contain multiple lines, one for each record.
The following command retrieves the AUDIX R1V8 maintenance : resolved
alarm : display screen data starting at midnight on October 26, 1994, writes a
summary of the transfer statistics to the screen, and writes output to a file named
ralarms.
getralar -r r1v8 -d 102694 -t 0000 -v > ralarms

RETURN

The following data is written to the file:
19941026,0157,19941026,0228,1024,1,36,21

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrem

12-116

getrem
Get remote message measurements

Syntax
getrem -f day [ -d mmddyy] -m machine [ -n nn] [ -r release] [ -v] [ -w] [ -V] [> ofile]
or
getrem -f month [ -d mmyy] -m machine [ -n nn] [ -r release] [ -v] [ -w] [ -V] [> ofile]

Description
This command retrieves the following screens by the date you specify in the
command options:
■

INTUITY AUDIX List Measurements Remote-Messages Day

■

DEFINITY AUDIX List Measurements Remote-Messages Day

■

R1 AUDIX (R1V3 and beyond) traffic : remote messages : day

This command retrieves the following screens by the month you specify in the
command options:
■

INTUITY AUDIX Measurements Remote-Messages Month

■

DEFINITY AUDIX Measurements Remote-Messages Month

■

R1 AUDIX (R1V3 and beyond) traffic : remote messages : month

No input is required. Retrieved data is written to standard output.
-f

Screen flag; must be followed by either day or month.

day

Retrieves the day version of the screen.

month

Retrieves the month version of the screen.

-d

Date flag; must be followed by mmddyy for the day screen or mmyy
for the month screen. Required for with AUDIX systems. If this flag
is omitted, the most recent date’s data is returned.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 072294, the data for July 22, 1994, is
retrieved.

mmyy

Retrieves data for the month and year indicated by mmyy. For
example, if you enter 0194 the data for January 1994 is retrieved.

-m

Remote machine flag; must be followed by machine.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrem

12-117

machine

Retrieves data for the specified remote machine. For machine, use
the machine name that was entered on the administrator’s INTUITY or
DEFINITY AUDIX screen or the R1 AUDIX system : translation:
machine : audix screen when the remote machine was added to the
network. If the machine name is more than one word (such as "new
york"), the name must be enclosed in quotation marks.

-n

Number of records flag; must be followed by nn. If you don’t include
this flag, only one record (hour or day) is returned. For the INTUITY or
DEFINITY AUDIX System, you may use the value all to retrieve all
records (hour or day) on or after any specified date and time.

nn

Retrieves the number (nn) of daily or monthly records that you
specify. For example, if you want to retrieve daily data and you
enter 072294 for mmddyy and then enter 5 for nn, the data from and
including July 22, 1994, and continuing through July 26, 1994, (the
data for July 22 and continuing through the next 5 days) is
retrieved.
The same is true for monthly records. If you enter 0194 for mmyy
and then enter 8 for nn, the data from and including January 1994
and continuing through August 1994 is retrieved.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX software (R1V3 and beyond)
System software. The default for the DEFINITY AUDIX System is
D-r3.2. The default for the INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrem

12-118

Errors
If you try to use this command with an R1 AUDIX R1V2 System, or if you enter an
invalid machine name, an error message appears on the screen.
If the date is not valid when communicating with an R1 AUDIX system, the
retrieval is aborted and no records are written.
When communicating with an INTUITY or DEFINITY AUDIX system, if the specified
date is before any valid date, the retrieval starts at the first date with data. If the
specified date is after a valid date, an error message is returned and the retrieval
is aborted.

Output Format
Output for the getrem command with the -f day option is formatted as follows,
with one record for each day.

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

machine name

C

10

r1v3+

D-r1.0+

I-r2.0+

2

starting date

D

8

r1v3+

D-r1.0+

I-r2.0+

3

ending time

T

4

r1v3+

D-r1.0+

I-r2.0+

4

local orig prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

5

local orig non-prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

6

remote orig prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

7

remote orig non-prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

8

local orig prime usage in seconds

N

7

r1v3+

D-r1.0+

I-r2.0+
I-r2.0+

local orig non-prime usage in seconds

N

7

r1v3+

D-r1.0+

10

9

remote orig prime usage in seconds

N

7

r1v3+

D-r1.0+

I-r2.0+

11

remote orig non-prime usage in seconds

N

7

r1v3+

D-r1.0+

I-r2.0+

12

local orig prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

13

local orig non-prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

14

remote orig prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

15

remote orig non-prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

16

local orig prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

17

local orig non-prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

18

remote orig prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

19

remote orig non-prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

20

local orig prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

21

local orig non-prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

22

remote orig prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

23

remote orig non-prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrem

12-119
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

N

6

r1v3+

D-r1.0+

I-r2.0+

local orig non-prime status sent

N

6

r1v3+

D-r1.0+

I-r2.0+

remote orig prime status sent

C

3

r1v3+

D-r1.0+

I-r2.0+

27

remote orig non-prime status sent

C

3

r1v3+

D-r1.0+

I-r2.0+

28

local orig prime status received

C

3

r1v3+

D-r1.0+

I-r2.0+

29

local orig non-prime status received

C

3

r1v3+

D-r1.0+

I-r2.0+

30

remote orig prime status received

N

6

r1v3+

D-r1.0+

I-r2.0+

31

remote orig non-prime status received

N

6

r1v3+

D-r1.0+

I-r2.0+

32

message transmission threshold exceptions

N

7

r1v3+

D-r1.0+

I-r2.0+

33

session failures on far end no answer

N

5

r1v3+

D-r1.0+

I-r2.0+

34

local orig prime headers sent

N

6

r1v4+

D-r1.0+

I-r2.0+

35

local orig non-prime headers sent

N

6

r1v4+

D-r1.0+

I-r2.0+

36

machine type

C

12

r1v4+

D-r1.0+

I-r2.0+

37

local orig prime admin updates

N

6

D-r3.2+

I-r5.0+

38

local orig non-prime admin updates

N

6

D-r3.2+

I-r5.0+

39

remote orig prime admin updates

N

6

D-r3.2+

I-r5.0+

40

remote orig non-prime admin updates

N

6

D-r3.2+

I-r5.0+

Seq.
No.

Field Name

24

local orig prime status sent

25
26

41

local voice components - prime

N

6

I-r5.0+

42

local voice components - non-prime

N

6

I-r5.0+

43

remote voice components - prime

N

6

I-r5.0+

44

remote voice components - non-prime

N

6

I-r5.0+

45

local FAX components - prime

N

6

I-r5.0+

46

local FAX components - non-prime

N

6

I-r5.0+

47

remote FAX components - prime

N

6

I-r5.0+

48

remote FAX components - non-prime

N

6

I-r5.0+

49

local binary attachments - prime

N

6

I-r5.0+

50

local binary attachments - non-prime

N

6

I-r5.0+

51

remote binary attachments - prime

N

6

I-r5.0+

52

remote binary attachments - non-prime

N

6

I-r5.0+

53

local text components - prime

N

6

I-r5.0+

54

local text components - non-prime

N

6

I-r5.0+

55

remote text components - prime

N

6

I-r5.0+

56

remote text components - non-prime

N

6

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrem

12-120

Output for the getrem command with the -f month argument is formatted as
follows, with one record for each month.
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

machine name

C

10

r1v3+

D-r1.0+

I-r2.0+

2

starting date

D

8

r1v3+

D-r1.0+

I-r2.0+

3

ending date

D

8

r1v3+

D-r1.0+

I-r2.0+

4

local orig prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

5

local orig non-prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

6

remote orig prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

7

remote orig non-prime transfer sessions

N

5

r1v3+

D-r1.0+

I-r2.0+

8

local orig prime usage in seconds

N

7

r1v3+

D-r1.0+

I-r2.0+

local orig non-prime usage in seconds

N

7

r1v3+

D-r1.0+

I-r2.0+

10

9

remote orig prime usage in seconds

N

7

r1v3+

D-r1.0+

I-r2.0+

11

remote orig non-prime usage in seconds

N

7

r1v3+

D-r1.0+

I-r2.0+

12

local orig prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

13

local orig non-prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

14

remote orig prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

15

remote orig non-prime average usage

N

7

r1v3+

D-r1.0+

I-r2.0+

16

local orig prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

17

local orig non-prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

18

remote orig prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

19

remote orig non-prime messages sent

N

6

r1v3+

D-r1.0+

I-r2.0+

20

local orig prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

21

local orig non-prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

22

remote orig prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

23

remote orig non-prime messages rejected

N

6

r1v3+

D-r1.0+

I-r2.0+

24

local orig prime status sent

N

6

r1v3+

D-r1.0+

I-r2.0+

25

local orig non-prime status sent

N

6

r1v3+

D-r1.0+

I-r2.0+

26

remote orig prime status sent

C

3

r1v3+

D-r1.0+

I-r2.0+

27

remote orig non-prime status sent

C

3

r1v3+

D-r1.0+

I-r2.0+

28

local orig prime status received

C

3

r1v3+

D-r1.0+

I-r2.0+

29

local orig non-prime status received

C

3

r1v3+

D-r1.0+

I-r2.0+

30

remote orig prime status received

N

6

r1v3+

D-r1.0+

I-r2.0+

31

remote orig non-prime status received

N

6

r1v3+

D-r1.0+

I-r2.0+

32

message transmission threshold exceptions

N

7

r1v3+

D-r1.0+

I-r2.0+

33

session failures on far end no answer

N

5

r1v3+

D-r1.0+

I-r2.0+

34

local orig prime headers sent

N

6

r1v4+

D-r1.0+

I-r2.0+

35

local orig non-prime headers sent

N

6

r1v4+

D-r1.0+

I-r2.0+

36

machine type

C

12

r1v4+

D-r1.0+

I-r2.0+

37

local orig prime admin updates

N

6

D-r3.2+

I-r5.0+

38

local orig non-prime admin updates

N

6

D-r3.2+

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrem

12-121
FIELD

VOICE MAIL VERSIONS
DEFINITY
AUDIX
System

INTUITY
AUDIX
System

6

D-r3.2+

I-r5.0+

D-r3.2+

I-r5.0+

Seq.
No.

Field Name

Type

Max.
Width

39

remote orig prime admin updates

N

R1
AUDIX
System

40

remote orig non-prime admin updates

N

6

41

local voice components - prime

N

6

I-r5.0+

42

local voice components - non-prime

N

6

I-r5.0+

43

remote voice components - prime

N

6

I-r5.0+

44

remote voice components - non-prime

N

6

I-r5.0+

45

local FAX components - prime

N

6

I-r5.0+

46

local FAX components - non-prime

N

6

I-r5.0+

47

remote FAX components - prime

N

6

I-r5.0+

48

remote FAX components - non-prime

N

6

I-r5.0+

49

local binary attachments - prime

N

6

I-r5.0+

50

local binary attachments - non-prime

N

6

I-r5.0+

51

remote binary attachments - prime

N

6

I-r5.0+

52

remote binary attachments - non-prime

N

6

I-r5.0+

53

local text components - prime

N

6

I-r5.0+

54

local text components - non-prime

N

6

I-r5.0+

55

remote text components - prime

N

6

I-r5.0+

56

remote text components - non-prime

N

6

I-r5.0+

Example
The following command retrieves the DEFINITY AUDIX List Measurements
Remote-Messages Day screen data for July 22, 1994, writes a summary of the
transfer statistics to the screen, and writes output to a file named daylds.
getrem -f day -d 072294 -m "new york" -v > daylds

RETURN

The following data is written to the file:
"new york",19940722,2359,2,84,1,62,111,4251,206,
8018,55,50,206,129,2,43,8,257,0,0,0,0,15,460,"n/a",
"n/a","n/a","n/a",0,25,0,0,0,0,"audix",0,0,0,0 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrlist

12-122

getrlist
Get remote extension list

Syntax
getrlist -m machine [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves all pages of the following screens for the specified
machine:
■

INTUITY AUDIX List Remote-Extensions

■

DEFINITY AUDIX List Remote-Extensions

■

R1 AUDIX (R1V3 and beyond) list : extension : remote

No input is required. Retrieved data is written to standard output.
-m

Remote machine flag; must be followed by machine.

machine

Retrieves data for the specified remote machine. For machine, use
the machine name that was entered on the administrator’s INTUITY or
DEFINITY AUDIX Machine or the AUDIX system : translation :
machine : audix screen when the remote machine was added to the
network. If the machine name is more than one word (such as "new
york"), the name must be enclosed in quotation marks.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) System
software. The default for the DEFINITY AUDIX System is D-r3.2. The
default for the INTUITY AUDIX System is I-r5.0

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrlist

12-123

Errors
If you try to use this command with an R1 AUDIX R1V2 System, an error message
appears on the screen.

Output Format
Output for the getrlist command is formatted as follow, with one record for each
remote subscriber.

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System
I-r2.0+

Field Name

Type

Max.
Width

1

extension

K

10

r1v3+

D-r1.0+

2

name

C

29

r1v3+

D-r1.0+

I-r2.0+

3

type

C

12

r1v3+

D-r1.0+

I-r2.0+

4

usage date

D

8

r1v3+

D-r1.0+

I-r2.0+

Example
The following command retrieves the INTUITY and DEFINITY AUDIX List Extension
Remote screen data for all INTUITY or DEFINITY AUDIX System Remote Subscribers for the specified remote machine (in this case seattle), writes a summary of
the transfer statistics to the screen, and writes output to a file named rextens.
getrlist -m seattle -v > rextens

RETURN

The following data is written to the file, one line for each remote subscriber:
"74101","Jones, Sam","administered",19940328

NEWLINE

The following command retrieves the AUDIX R1V8 list : extension : remote screen
data for all R1 AUDIX System remote subscribers for the specified remote
machine (in this case seattle), writes a summary of the transfer statistics to the
screen, and writes output to a file named rextens.
getrlist -m seattle -r r1v8 -v > rextens

RETURN

The following data is written to the file, one line for each remote subscriber:
"15498","Fong, Ming","a",19940208

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrsub

12-124

getrsub
Get remote subscriber data

Syntax
getrsub -m machine/trusted server [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command retrieves data for the subscribers and machine that you specify
for the following screens:
■

INTUITY AUDIX Display Remote-Subscriber

■

DEFINITY AUDIX Display Remote-Subscriber

■

R1 AUDIX (R1V3 and beyond) subscriber : remote

Use subscriber extension or text address as input. Retrieved data is written to
standard output.

-m

Remote machine flag; must be followed by machine or trusted
server name.

machine
/trusted
server

Retrieves data for the specified remote machine or trusted server.
For machine, use the machine name that was entered on the
administrator’s INTUITY or DEFINITY AUDIX Machine or the R1
AUDIX system : translation : machine : audix screen when the
remote machine was added to the network. If the machine name is
more than one word (such as "new york"), the name must be
enclosed in quotation marks.
For trusted server, use the trusted server name that was entered
on the INTUITY AUDIX Trusted Server Profile screen when the
server was added to that system.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) System
software. The default for the DEFINITY AUDIX System is D-r3.2.
The default for the INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrsub

12-125

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify i, you must specify an input file
(< ifile) from which the extensions are read.

< ifile

Specifies the name of an input file you have created. The filename
must be preceded by the symbol <.
This file contains one or more extensions (or text addresses) of the
remote subscribers whose traffic data this command retrieves. If
you don’t specify an input file, you must specify the i option, which
allows you to type the individual extensions (or text addresses)
directly from your keyboard after entering this command. (The
output from the getrlist command or the gettlist command could
be the input for this command.)

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

Errors
If you try to use this command with R1V2, an error message appears.
If the extension does not belong to a valid voice mail subscriber, you receive an
error message that gives the record number containing the invalid extension. If
more records exist, retrieval continues.

Input Format
The Input Format for the getrsub command when the -m machine option refers
to a remote voice mail system consists of one record for each remote subscriber.

FIELD
Seq.
No.
1

VOICE MAIL VERSIONS

Field Name

Type

Max.
Width

R1
AUDIX
System

extension

K

10

r1v3+

DEFINITY
AUDIX
System
D-r1.0+

INTUITY
AUDIX
System
I-r2.0+

The Input Format for the getrsub command when the -m machine option refers
to a trusted server consists of one record for each remote subscriber.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrsub

12-126

FIELD

VOICE MAIL VERSIONS

Seq.
No.

Field Name

Type

Max.
Width

1

text address

C

64

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System
I-r4.0+

Output Format
Output format for the getrsub command for a remote subscriber on a remote
voice mail system is formatted as follows.
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

D-r1.0+

I-r2.0+
I-r2.0+

Field Name

Type

Max.
Width

1

name

C

29

r1v3+

2

extension

K

10

r1v3+

D-r1.0+

3

address

C

31

r1v3+

D-r1.0+

I-r2.0+

4

administered indicator

L

1

r1v3+

D-r1.0+

I-r2.0+

5

machine name 1

C

10

r1v3+

D-r1.0+

I-r2.0+

6

machine name 2

C

10

r1v3+

D-r1.0+

I-r2.0+

7

machine name 3

C

10

r1v3+

D-r1.0+

I-r2.0+

8

machine name 4

C

10

r1v3+

D-r1.0+

I-r2.0+

9

machine name 5

C

10

r1v3+

D-r1.0+

I-r2.0+

10

machine name 6

C

10

r1v3+

D-r1.0+

I-r2.0+

11

machine name 7

C

10

r1v3+

D-r1.0+

I-r2.0+

12

machine name 8

C

10

r1v3+

D-r1.0+

I-r2.0+

13

voiced name

L

1

r1v3+

D-r1.0+

I-r2.0+

14

non-administered type

C

10

r1v3+

D-r1.0+

I-r2.0+

15

last usage date

D

8

r1v3+

D-r1.0+

I-r2.0+

16

new name

C

29

r1v3+

D-r1.0+

I-r2.0+

17

new extension

K

10

r1v3+

D-r1.0+

I-r2.0+

18

community id

N

2

r1v5+

D-r1.0+

I-r2.0+

19

machine name 9

C

10

r1v5+

D-r1.0+

I-r2.0+

20

machine name 10

C

10

r1v5+

D-r1.0+

I-r2.0+

21

machine name 11

C

10

r1v5+

D-r1.0+

I-r2.0+

22

machine name 12

C

10

r1v5+

D-r1.0+

I-r2.0+

23

machine name 13

C

10

r1v5+

D-r1.0+

I-r2.0+

24

machine name 14

C

10

r1v5+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrsub

12-127
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

C

10

r1v5+

D-r1.0+

I-r2.0+

machine name 16

C

10

r1v5+

D-r1.0+

machine name 17

C

10

Seq.
No.

Field Name

25

machine name 15

26
27

I-r2.0+
I-r4.0+

Output for the getrsub command for a remote subscriber served by a trusted
server is formatted as follows.
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

name

C

29

I-r4.0+

2

text address

C

64

I-r4.0+

3

administered indicator

L

1

I-r4.0+

4

trusted server name

C

10

I-r4.0+

5

voiced name

L

1

I-r4.0+

6

non-administered type

C

10

I-r4.0+

7

last usage date

D

8

I-r4.0+

8

community id

N

2

I-r4.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getrsub

12-128

Example
The following command retrieves the INTUITY or DEFINITY AUDIX Display
Remote-Subscriber screen data for one or more remote subscribers from the
input file called allsubs, writes a summary of the transfer statistics to the screen,
and writes output to a file named johndoe.
getrsub -m seattle -v < allsubs > johndoe

RETURN

The following data is written to the file:
"Doe, John","74101","74101","n","seattle","","",
"","","","","","n","administered",19940328,"","",3,
"","","","","","","","" NEWLINE
The following command retrieves the AUDIX R1V8 subscriber : remote screen
data for one remote subscriber from the input file called allsubs, writes a
summary of the transfer statistics to the screen, and writes output to a file named
johndoe.
getrsub -r r1v8 -m seattle -v < allsubs > johndoe

RETURN

The following data is written to the file:
"Doe, John","67890","","y","seattle","","","","","","",
"","y","",19940117,"","",1,"","","","","","","",""
NEWLINE

The following command retrieves the INTUITY AUDIX (I-r4.0 and beyond) Display
Remote-Subscriber screen data when the -m machine option refers to a trusted
server. The input file, trsub, contains the text address ("jdoe@aol.com"), and the
output is written to the output file, jdoe.
getrsub -r I-r4.0 -m internet < trsub > jdoe

RETURN

The following data is written to the file:
"Doe, John","jdoe@aol.com","n","internet","n",
"verified",19990226,1 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getserve

12-129

getserve
Get trusted server list

Syntax
getserve [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves all pages for the following screen:
■

INTUITY AUDIX List Trusted-servers
No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX (I-r4.0
and beyond) System software. The default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified, data
is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getserve

12-130

Errors
If you try to use this command with the R1 AUDIX or DEFINITY AUDIX System, an
error message appears.

Output Format
Output for the getserve command is as follows, one record for each trusted
server.

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

trusted server name

C

10

I-r4.0+

2

access to cross domain delivery

L

1

I-r4.0+

3

IP address

C

15

I-r4.0+

4

trusted server ID

N

2

I-r4.0+

5

service name

C

64

I-r4.0+

Example
The following command retrieves the INTUITY AUDIX List trusted-servers screen
data for all servers, writes a summary of the transfer statistics to the screen, and
writes output to a file named servers.
getserve -v > servers RETURN
The following data is written to the file, one line for each server:
"drnote11","y","135.9.181.42",14,"drmid10"

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getspfea

12-131

getspfea
Get special features measurements

Syntax
getspfea -f day [ -d mmddyy] [ -n nn] [ -r release] [ -s switch type] [ -v] [ -w] [ -V] [> ofile]
or
getspfea -f hour [ -d mmddyy [ -h hh][ -n nn]] [ -r release] [ -s switch type] [ -v] [ -w] [ -V]
[> ofile]

Description
This command retrieves the following screens for the date that you specify:
■

INTUITY AUDIX List Measurements Special-Features Day

■

DEFINITY AUDIX List Measurements Special-Features Day

This command retrieves the following screens for the hour that you specify:
■

INTUITY AUDIX List Measurements Special-Features Hour

■

DEFINITY AUDIX List Measurements Special-Features Hour

It also retrieves the date and switch type that you specify in the command
options for the following screens:
■

R1 AUDIX (R1V3 and beyond) traffic : special features : day

■

R1 AUDIX (R1V3 and beyond) traffic : special features : hour

No input is required. Retrieved data is written to standard output.

-f

Screen flag; must be followed by either day or hour.

day

Retrieves the day version of the screen data.

hour

Retrieves the hour version of the screen data.

-d

Date flag; must be followed by mmddyy. Required when used with
the R1 AUDIX system. If this flag is omitted, the most recent date’s
data is returned.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 012295 without subsequently entering the
n option, only the data for January 22, 1995, is retrieved.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getspfea

12-132

-h

Time of the day flag; must be followed by hh. Required when used
with AUDIX system. If this flag is omitted, the first hour (hour 0) of
the specified day or the current hour (if no day is specified) is
returned.

hh

Retrieves data for the hour (hh) of the day (mmddyy) that you have
specified already. For example, if you enter 15 without
subsequently entering the n option, only the data from 3:00 p.m. to
4:00 p.m. is retrieved.

-n

Number of records flag; must be followed by nn. If you don’t include
this flag, only one record (hour or day) is returned.

nn

Retrieves the number (nn) of hourly or daily records that you
specify. For example, if you want to retrieve hourly data and you
enter 15 for hh and then enter 5 for nn, the data for the hours
between 3:00 p.m. and 8:00 p.m. (the data beginning at 3:00 and
continuing through the next five hours) is retrieved.
The same is true for daily records. If you enter 012295 for mmddyy
and then enter 8 for nn, the data from and including January 22,
1995, and continuing through January 29, 1995, is retrieved.
For the INTUITY and DEFINITY AUDIX systems, you may use the
value all to retrieve all records (hour or day) on or after any
specified date and time.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) System
software. The default for DEFINITY AUDIX is D-r3.2. The default for
INTUITY AUDIX is I-r5.0.

-s

Switch connection type flag; must be followed by switch type.

switch
type

Retrieves data for the specified switch connection type. Applies to
only R1 AUDIX. See AUDIX R1 Release 1, Version 8 Forms
Reference 585-305-209 for a list of switch types.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getspfea

12-133

Errors
If you try to use this command with an R1 AUDIX R1V2 System, an error message
appears.
If either the date or time is not valid when communicating with an R1 AUDIX
System, the retrieval aborts and no records are written.
With the INTUITY and DEFINITY AUDIX systems, if the specified date is before any
valid date, the retrieval starts at the first date with data. If the specified date is
after a valid date, an error message is returned and the retrieval aborts.

Output Format
Output for the getspfea command with the -f day option is formatted as follows
when communicating with INTUITY AUDIX, DEFINITY AUDIX, and R1 AUDIX (with
a switch integration other than SL-1) Systems, with one record for each day

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System
I-r2.0+

Field Name

Type

Max.
Width

1

starting date

D

8

r1v3+

D-r1.0+

2

ending time

T

4

r1v3+

D-r1.0+

I-r2.0+

3

average number of CA ports in use

N

2.1

r1v3+

D-r1.0+

I-r2.0+

4

maximum simultaneous CA ports

N

2

r1v3+

D-r1.0+

I-r2.0+

5

average number of VM ports in use

N

2.1

r1v3+

D-r1.0+

I-r2.0+

6

maximum simultaneous VM ports

N

2

r1v3+

D-r1.0+

I-r2.0+

7

average number of AA ports in use

N

2.1

r1v3+

D-r1.0+

I-r2.0+

8

maximum simultaneous AA ports

N

2

r1v3+

D-r1.0+

I-r2.0+

maximum simultaneous outcalls

N

3

r1v3+

D-r1.0+

I-r2.0+

10

9

outcalls attempted

N

8

r1v3+

D-r1.0+

I-r2.0+

11

outcalls completed

N

8

r1v3+

D-r1.0+

I-r2.0+

12

outcalls rescheduled

N

8

r1v3+

D-r1.0+

I-r2.0+

13

calls answered without connect

N

8

r1v4+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getspfea

12-134

Output for the getspfea command with the -f hour option is formatted as follows
when communicating with INTUITY AUDIX, DEFINITY AUDIX, and R1 AUDIX (with
switch integration other than SL-1) Systems, with one record for each hour.
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

8

r1v3+

D-r1.0+

I-r2.0+

2

r1v3+

D-r1.0+

I-r2.0+

Seq.
No.

Max.
Width

Field Name

Type

1

starting date

D

2

starting hour

N

3

ending time

T

4

r1v3+

D-r1.0+

I-r2.0+

4

average number of CA ports in use

N

2.1

r1v3+

D-r1.0+

I-r2.0+

5

maximum simultaneous CA ports

N

2

r1v3+

D-r1.0+

I-r2.0+

6

average number of VM ports in use

N

2.1

r1v3+

D-r1.0+

I-r2.0+

7

maximum simultaneous VM ports

N

2

r1v3+

D-r1.0+

I-r2.0+

8

average number of AA ports in use

N

2.1

r1v3+

D-r1.0+

I-r2.0+

9

maximum simultaneous AA ports

N

2

r1v3+

D-r1.0+

I-r2.0+

10

maximum simultaneous outcalls

N

3

r1v3+

D-r1.0+

I-r2.0+

11

outcalls attempted

N

8

r1v3+

D-r1.0+

I-r2.0+

12

outcalls completed

N

8

r1v3+

D-r1.0+

I-r2.0+

13

outcalls rescheduled

N

8

r1v3+

D-r1.0+

I-r2.0+

14

calls answered without connect

N

8

r1v4+

D-r1.0+

I-r2.0+

Output for the getspfea command with the -f day when communicating with an
R1 AUDIX (using SL1 switch integration) System is formatted as follows, with one
record for each day.
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

starting date

D

8

r1v4+

ending time

T

4

r1v4+

3

avg number of integrated ports in use

N

2.1

r1v4+

4

maximum simultaneous integrated ports

N

2

r1v4+
r1v4+

Seq.
No.

Field Name

1
2

5

avg number of AA 1 ports in use

N

2.1

6

maximum simultaneous AA 1 ports

N

2

r1v4+

7

avg number of AA 2 ports in use

N

2.1

r1v4+

8

maximum simultaneous AA 2 ports

N

2

r1v4+

avg number of AA 3 ports in use

N

2.1

r1v4+

10

9

maximum simultaneous AA 3 ports

N

2

r1v4+

11

avg number of non-integrated ports in use

N

2.1

r1v4+

12

max simultaneous non-integrated ports

N

2

r1v4+

13

maximum simultaneous outcalls

N

2

r1v4+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getspfea

12-135
FIELD

VOICE MAIL VERSIONS
Max.
Width

R1
AUDIX
System

Seq.
No.

Field Name

Type

14

outcalls attempted

N

8

r1v4+

15

outcalls completed

N

8

r1v4+

16

outcalls rescheduled

N

8

r1v4+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Output for the getspfea command with the -f hour option when communicating
with an R1 AUDIX (using SL1 switch integration) system is formatted as follows,
with one record for each hour.
FIELD

VOICE MAIL VERSIONS

Seq.
No.

Field Name

Type

Max.
Width

R1
AUDIX
System

1

starting date

D

8

r1v4+

2

starting hour

N

2

r1v4+

3

ending time

T

4

r1v4+

4

avg number of integrated ports in use

N

2.1

r1v4+

5

maximum simultaneous integrated ports

N

2

r1v4+

6

avg number of AA 1 ports in use

N

2.1

r1v4+

7

maximum simultaneous AA 1 ports

N

2

r1v4+

8

avg number of AA 2 ports in use

N

2.1

r1v4+

maximum simultaneous AA 2 ports

N

2

r1v4+

10

9

avg number of AA 3 ports in use

N

2.1

r1v4+

11

maximum simultaneous AA 3 ports

N

2

r1v4+

12

avg number of non-integrated ports in use

N

2.1

r1v4+

13

max simultaneous non-integrated ports

N

2

r1v4+

14

maximum simultaneous outcalls

N

2

r1v4+

15

outcalls attempted

N

8

r1v4+

16

outcalls completed

N

8

r1v4+

17

outcalls rescheduled

N

8

r1v4+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getspfea

12-136

Example
The following command retrieves the INTUITY and DEFINITY AUDIX List Measurements Special-Features Day screen data for December 12, 1994, writes a
summary of the transfer statistics to the screen, and writes output to a file named
daylds.
getspfea -f day -d 121294 -v > daylds

RETURN

The following data is written to the file:
19941212,2359,0.0,0,0.0,0,0.0,0,0,0,0,0,0

NEWLINE

The following command retrieves the R1 AUDIX R1V8 traffic : special features :
day screen data for December 12, 1994, writes a summary of the transfer
statistics to the screen, and writes output to a file named daylds when the switch
connection is DCIU.
getspfea -f day -d 121294 -s dciu-sci -r r1v8 v > daylds

RETURN

The following data is written to the file:
19941212,2359,0.0,0,0.0,0,0.0,0,0,0,0,0,0

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsub

12-137

getsub
Get local subscriber data

Syntax
getsub [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command retrieves the following screens for the specified subscriber(s):
■

INTUITY AUDIX Display Subscriber

■

DEFINITY AUDIX Display Subscriber

■

R1 AUDIX subscriber : local

Use subscriber extensions as input. Retrieved data is written to standard output.

-r

Release flag: must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX System software. The default for the
DEFINITY AUDIX System is D-r3.2. The default for the INTUITY
AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the extensions will be read.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsub

12-138

< ifile

Specifies the name of an input file you have created. The filename
must be preceded by the symbol <.
This file contains one or more extensions of the subscribers whose
traffic data this command retrieves. If you don’t specify an input file,
you must specify the -i option, which allows you to type the
individual extensions directly from your keyboard after entering this
command.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

Errors
If the extension does not belong to a valid voice mail system subscriber, an error
message appears, giving the record number containing the invalid extension. If
more records exist, retrieval continues.

Input Format
The input format for getsub consists of one record for each subscriber:

FIELD

Seq.
No.
1

VOICE MAIL VERSIONS

Field Name

Type

Max.
Width

extension

K

10

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

r1v2+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsub

12-139

Output Format
Output for getsub for INTUITY AUDIX, DEFINITY AUDIX, and AUDIX (R1V4 and
beyond) Systems is formatted as follows, one record for each subscriber
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

1

name

C

29

r1v4+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v4+

D-r1.0+

I-r2.0+

3

class of service

C

8

r1v4+

D-r1.0+

I-r2.0+

4

password

K

15

r1v4+

D-r1.0+

I-r2.0+

5

switch number

N

2

r1v4+

D-r1.0+

I-r2.0+

6

miscellaneous 1

C

11

r1v4+

D-r1.0+

I-r2.0+

7

covering extension

K

10

r1v4+

D-r1.0+

I-r2.0+

8

addressing format

C

9

r1v4+

D-r1.0+

I-r2.0+

9

CA permissions

C

14

r1v4+

D-r1.0+

I-r2.0+

announcement control

C

1

r1v4+

D-r1.0+

I-r2.0+

11

outcalling

L

1

r1v4+

D-r1.0+

I-r2.0+

12

text service machine

C

10

r1v4+

D-r1.0+

I-r2.0+

13

user id

C

30

r1v4+

D-r1.0+

I-r2.0+

14

incoming mailbox LIFO/FIFO

C

4

r1v4+

D-r1.0+

I-r2.0+

15

incoming mailbox order

C

3

r1v4+

D-r1.0+

I-r2.0+

16

new retention time

N

3

r1v4+

D-r1.0+

I-r2.0+

17

old retention time

N

3

r1v4+

D-r1.0+

I-r2.0+

18

unopened retention time

N

3

r1v4+

D-r1.0+

I-r2.0+

19

outgoing mailbox LIFO/FIFO

C

4

r1v4+

D-r1.0+

I-r2.0+

20

outgoing mailbox order

C

5

r1v4+

D-r1.0+

I-r2.0+

21

file cabinet retention time

N

3

r1v4+

D-r1.0+

I-r2.0+

22

del/non del retention time

N

3

r1v4+

D-r1.0+

I-r2.0+

23

max VM message length

N

4

r1v4+

D-r1.0+

I-r2.0+

24

min VM space required

N

4

r1v4+

D-r1.0+

I-r2.0+

25

max CA message length

N

4

r1v4+

D-r1.0+

I-r2.0+

26

min CA space required

N

4

r1v4+

D-r1.0+

I-r2.0+

27

max number of mailing lists

N

3

r1v4+

D-r1.0+

I-r2.0+

28

max total mailing list entries

N

5

r1v4+

D-r1.0+

I-r2.0+

29

max mailbox size

N

5

r1v4+

D-r1.0+

I-r2.0+

30

guaranteed space

N

4

r1v4+

D-r1.0+

I-r2.0+

31

new subscriber name

C

29

r1v4+

D-r1.0+

I-r2.0+

32

new extension

K

10

r1v4+

D-r1.0+

I-r2.0+

33

locked

C

1

r1v4+

D-r1.0+

I-r2.0+

34

community id

N

2

r1v5+

D-r1.0+

I-r2.0+

35

broadcast mailbox

L

1

r1v5+

D-r1.0+

I-r2.0+

10

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsub

12-140
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

L

1

r1v5+

D-r1.0+

I-r2.0+

5

r1v5+

D-r1.0+

I-r2.0+

2

r1v6+

D-r1.0+

I-r2.0+

1

D-r3.0+

I-r3.2+

C

14

D-r3.0+

I-r3.2+

CA primary announcement set

C

14

D-r3.0+

I-r3.2+

CA secondary announcement set

C

14

D-r3.0+

I-r3.2+

43

IMAPI access

L

1

D-r3.1+

I-r3.2+

44

IMAPI voice file/ message transfer

L

1

D-r3.1+

I-r3.2+

45

secondary extension

K

10

I-r3.3+

46

FAX creation

L

1

I-r3.3+

47

trusted server access

L

1

I-r4.0+

48

account code

C

16

I-r5.0+

Seq.
No.

Field Name

36

priority messages

37

broadcast permissions

C

38

end of message warning time

N

39

CA language choice

L

40

login announcement set

41
42

49

email address

C

64

I-r5.0+

50

miscellaneous 2

C

11

I-r5.0+

51

miscellaneous 3

C

11

I-r5.0+

52

miscellaneous 4

C

11

I-r5.0+

Output for the getsub command when communicating with R1 AUDIX systems
prior to R1V4 is formatted as follows, one record for each subscriber.
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

Field Name

Type

Max.
Width

1

name

C

29

r1v2-r1v3

2

extension

K

5

r1v2-r1v3

3

class of service

C

8

r1v2-r1v3

4

switch number

N

2

r1v2-r1v3

5

miscellaneous

C

9

r1v2-r1v3

6

covering extension

C

5

r1v2-r1v3

7

addressing format

C

1

r1v2-r1v3

8

CA permissions

C

1

r1v2-r1v3

9

announcement control

C

1

r1v2-r1v3

10

incoming mailbox LIFO/FIFO

C

1

r1v2-r1v3

11

incoming mailbox order

C

3

r1v2-r1v3

12

new retention time

N

3

r1v2-r1v3

13

old retention time

N

3

r1v2-r1v3

14

unopened retention time

N

3

r1v2-r1v3

15

outgoing mailbox LIFO/FIFO

C

1

r1v2-r1v3

16

outgoing mailbox order

C

5

r1v2-r1v3

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsub

12-141
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

N

3

r1v2-r1v3

del/non del retention time

N

3

r1v2-r1v3

max VM message length

N

4

r1v2-r1v3

min VM space required

N

4

r1v2-r1v3

max CA message length

N

4

r1v2-r1v3

Seq.
No.

Field Name

17

file cabinet retention time

18
19
20
21
22

min CA space required

N

4

r1v2-r1v3

23

max number of mailing lists

N

3

r1v2-r1v3

24

max total mailing list entries

N

5

r1v2-r1v3

25

max mailbox size

N

4

r1v2-r1v3

26

guaranteed space

N

4

r1v2-r1v3

27

locked

L

1

r1v2-r1v3

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Example
The following command retrieves the DEFINITY AUDIX Display Subscriber
screen data for subscriber(s) from the input file called sub, writes a summary of
the transfer statistics to the screen, and writes output to a file called johndoe.
getsub -v < sub > johndoe

RETURN

The following data is written to the file:
"Doe, John","73102","class00","",1,"","","extension",
"call-answer","n","n","","","fifo","nuo",10,10,10,
"fifo","ufdan",10,5,300,32,120,8,25,250,1200,0,"","",
"n",1,"n","n","none",0,"y","standard","french-c",
"lat-span","n","n" NEWLINE
The following command retrieves the R1 AUDIX subscriber : local screen data for
one subscriber from the input file called sub, writes a summary of the transfer
statistics to the screen, and writes output to a file named johndoe.
getsub -r r1v8 -v < sub > johndoe

RETURN

The following data is written to the file:
"Doe, John","67890","def","",2,"","","e","c","n",
"y","","","f","nuo",30,20,30,"f","undfa",30,5,240,32,
240,8,25,500,1200,0,"","","n",1,"n","y","n",10 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getswitc

12-142

getswitc
Get system switch connection data

Syntax
getswitc [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves the switch type from the following screens:
■

INTUITY AUDIX Display System-Parameters Customer-options

■

DEFINITY AUDIX Display System-Parameters Features (D-r1.0 only)

■

DEFINITY AUDIX Display System-Parameters Customer-options(D-r2.0+)

■

R1 AUDIX (R1V4_5 and beyond) system : translation : switch connection

No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the release of the INTUITY AUDIX, DEFINITY
AUDIX or R1 AUDIX (R1V4_5 and beyond) System software. The
default for the DEFINITY AUDIX System is D-r3.2. The default for the
INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

Errors
If you try to use this command with an R1 AUDIX R1V4, R1V3, or R1V2 System,
an error message appears.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getswitc

12-143

Output Format
Output for the getswitc command is formatted as follows.
FIELD

Seq.
No.

VOICE MAIL VERSIONS

Field Name

Type

Max.
Width

1

switch connection type

C

11

2

port emulation type

C

5

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

r1v4_5+

D-r1.0+

I-r2.0+

D-r2.0+

Example
The following command retrieves the DEFINITY AUDIX Display
System-Parameters Customer-options screen data, writes a summary of the
transfer statistics to the screen, and writes output to a file named switchtype.
getswitc -v > switchtype

RETURN

The following data is written to the file:
"dciu-sci","tn746"

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsys

12-144

getsys
Get administration log data

Syntax
getsys

[-d mmddyy] [-h hhmm]] [-t error type] [-n nn] [-r release] [-v] [-w]
[-V] [ > ofile]

Description
This command retrieves all pages of the following screens for the search information that you specify:
■

INTUITY AUDIX Display Administrator’s Log

■

DEFINITY AUDIX Display Administration-Log

■

R1 AUDIX (R1V3 and beyond) system : log : display

For INTUITY AUDIX and DEFINITY AUDIX Systems, ADAP updates the
specification fields of the AUDIX Display Administration-Log screen while
retrieving the screen data. For the R1 AUDIX System, ADAP updates the system :
log : specification screen before retrieving the screen data. The voice mail
system retains the values you supply after the retrieval is completed.
If you omit the option and its qualifier (for example, error type), then all log entries
are returned.
For a complete description of error log types, see the appropriate voice mail
administration or maintenance manual (listed in the DEFINITY AUDIX System
Documentation Guide, 585-300-011, or the AUDIX Documentation Guide,
585-300-010).
No input is required. All errors retrieved are written to standard output.

-d

Date flag; must be followed by mmddyy. Required for AUDIX
systems. The default is to retrieve entries from all dates.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 012294, the data for January 22, 1994, is
retrieved.

-h

Time of the day flag; must be followed by hhmm.
This flag is required for AUDIX systems. The default retrieves all
entries starting at the specified date.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsys

12-145

hhmm

Retrieves data from the hour (hhmm) of the day (mmddyy) that you
have specified already, to the time that you enter this command.
For example, if you enter 1500 at 6:00 p.m., the data from 3:00
p.m. to 6:00 p.m. is retrieved. Midnight is represented by 0000.

-t

Error type flag; must be followed with error type.

error
type

Retrieves log entries for the specified error type. See the
appropriate voice mail system administration or maintenance
manual for a list of error types.

-n

Number of log entries flag; must be followed by nn.

nn

Retrieves the number (nn) of log entries that you specify. If you
don’t specify this flag or you use the word all, all alarm entries that
meet the specification criteria are returned.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) System
software. The default for the DEFINITY AUDIX system is D-r3.2. The
default for the INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

Errors
If you use this command with an R1 AUDIX R1V2 System, an error message
appears. Otherwise, if no log entries exist that fit the specified search, no output
is written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsys

12-146

Output Format
Output for getsys is formatted as follows, with one record for each log entry.
FIELD

Seq.
No.
1

VOICE MAIL VERSIONS

Field Name

Type

Max.
Width

date

D

8

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

r1v3+

D-r1.0+

I-r2.0+

2

time

T

4

r1v3+

D-r1.0+

I-r2.0+

3

type/event id

C

14

r1v3+

D-r1.0+

I-r2.0+

4

error/message/alarm

C

118

r1v3+

D-r1.0+

I-r2.0+

5

count

C

3

I-r2.0+

6

application

C

2

I-r2.0+

Example
The following command retrieves the DEFINITY AUDIX Display Administration-Log screen data from 12:25 p.m. on November 14, 1994, to the time that the
command was entered, writes a summary of the transfer statistics to the screen,
and writes output to a file named errors.
getsys -d 111494 -h 1225 -v > errors

RETURN

The following data is written to the file, one line for each log entry:
19941114,1225,"clrd","ADMINISTRATION LOG RECREATED
DURING INIT" NEWLINE
19941114,1225,"clrd","CHRONO LOG RECREATED DURING INIT"
NEWLINE

19941114,1225,"clrd","RESOLVED ALARM LOG RECREATED
DURING INIT" NEWLINE
19941114,1411,"time","Time synchronization with switch
was successful" NEWLINE
The following command retrieves the R1 AUDIX R1V8 system : log : display
screen data from 8:05 a.m. on January 26, 1995, to the time that the command
was entered, writes a summary of the transfer statistics to the screen, and writes
output to a file named errors.
getsys -r r1v8 -d 012695 -h 0805 -v > errors

RETURN

The following data is written to the file, one line for each log entry:
19950126,0805,"nsua","Subscriber update audit
requested" NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysat

12-147

getsysat
Get system attendant data

Syntax
getsysat [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command retrieves the following screens:
■

INTUITY AUDIX Display Subscriber

■

DEFINITY AUDIX Display Subscriber

■

R1 AUDIX (R1V3 and beyond) system : attendant

Use subscriber extensions as input. Retrieved data is written to standard output.
(The output of the getatt command is good input for this command.)
-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) System
software. The default for the DEFINITY AUDIX system is D-r3.2. The
default for the INTUITY AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the
transfer.Unless -i is specified, pressing v while the command is
executing sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file (<
ifile) from which the extensions are read.

< ifile

Specifies the name of an input file you have created. The filename
must be preceded by the symbol <.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysat

12-148

This file contains one or more extensions of the system attendants.
If you ran the getatt command and redirected its output to a file,
you could use this file as input to the getsysat command. If you
don’t specify an input file, you must specify the -i option, which
allows you to type the individual extensions directly from your
keyboard after entering this command.
> ofile

Specifies the name of the file to which data are written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

Errors
If you try to use this command with an R1 AUDIX R1V2 System, an error message
appears.
If the extension does not belong to a valid voice mail automated attendant, an
error message appears giving the record number containing the invalid
extension. If more records exist, retrieval continues.

Input Format
The Input Format for the getsysat command consists of one record for each
automated attendant:
FIELD

Seq.
No.
1

VOICE MAIL VERSIONS

Field Name

Type

Max.
Width

extension

K

10

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

r1v3+

D-r1.0+

I-r2.0+

Output Format
Output for the getsysat command is formatted as follows, with one record for
each system attendant.

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

name

C

29

r1v3+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v3+

D-r1.0+

I-r2.0+

3

allow call transfer

L

1

r1v3+

D-r1.0+

I-r2.0+

4

button 1 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysat

12-149
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

5

button 1 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

6

button 2 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

7

button 2 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

8

button 3 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

9

button 3 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

10

button 4 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

11

button 4 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

12

button 5 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

13

button 5 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

14

button 6 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

15

button 6 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

16

button 7 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

17

button 7 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

18

button 8 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

19

button 8 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

20

button 9 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

21

button 9 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

22

button 0 extension

C

10

r1v3+

D-r1.0+

I-r2.0+

23

button 0 comment

C

29

r1v3+

D-r1.0+

I-r2.0+

24

default timeout extension

K

10

r1v3+

D-r1.0+

I-r2.0+

25

length of timeout in seconds

C

1

r1v3+

D-r1.0+

I-r2.0+

26

button 1 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

27

button 2 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

28

button 3 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

29

button 4 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

30

button 5 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

31

button 6 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

32

button 7 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

33

button 8 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

34

button 9 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

35

button 0 treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

36

timeout treatment

C

14

r1v5+

D-r1.0+

I-r2.0+

37

timeout comment

C

29

r1v5+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysat

12-150

Example
The following command retrieves the INTUITY or DEFINITY AUDIX Display Subscriber screen data for one subscriber from the input file called attend, writes a
summary of the transfer statistics to the screen, and writes output to a file named
attfile.
getsysat -v < attend > attfile

RETURN

The following data is written to the file:
"Main Attendant","60099","n","60001","Sales","60002",
"Personnel","60003","Purchasing","60004","Accounting",
"60005","Engineering","","","","","","","","","","",
"60010","5","call-answer","call-answer","call-answer",
"call-answer","call-answer","","","","","",
"call-answer","" NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsyscd

12-151

getsyscd
Get system Call Detail Recording data

Syntax
getsyscd [-r release] [-v] [-w] [-V] [> ofile]

Description
This command retrieves the R1 AUDIX (R1V5 and beyond) system: cdr screen
data.
NOTE:
You must have the separately-purchased Call Detail Recording (CDR)
software to receive and use this command.
No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the R1 AUDIX software
(R1V5 and beyond). The default is D-r3.2.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen

Errors
If you use this command with the INTUITY AUDIX, DEFINITY AUDIX, or
R1 AUDIX Systems software prior to R1V5, an error message appears on the
screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsyscd

12-152

Output Format
Output for the getsyscd command is formatted as follows.
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

Field Name

Type

Max.
Width

1

call detail recording active

L

1

r1v5+

2

max number of call detail records

N

6

r1v5+

3

voice session record collection

L

1

r1v5+

4

outgoing call record collection

L

1

r1v5+

5

network session record collection

L

1

r1v5+

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Example
The following command retrieves the R1 AUDIX R1V8 system : cdr screen data,
writes a summary of the transfer statistics to the screen, and writes output to a file
named syscdr.
getsyscd -r r1v8 -v > syscdr

RETURN

The following data is written to the file:
"y",50000,"y","y","n"

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysfe

12-153

getsysfe
Get system parameters features data

Syntax
getsysfe [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves the following screens:
■

INTUITY AUDIX Display System-Parameters Features

■

DEFINITY AUDIX Display System-Parameters Features

No input is required. Retrieved data is written to standard output.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX or the
DEFINITY AUDIX System software. The default for the DEFINITY
AUDIX system is D-r3.2. The default for the INTUITY AUDIX System
is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

Errors
If you try to use this command with an R1 AUDIX System, an error message
appears on the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysfe

12-154

Output Format
Output for the getsysfe command when communicating with a DEFINITY AUDIX
system is formatted as follows:
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

Field Name

Type

Max.
Width

1

switch connection type

C

11

D-r1.0+

2

login retries

N

1

D-r1.0+

3

consecutive invalid login attempts

N

3

D-r1.0+

4

system guest password

K

15

D-r1.0+

5

minimum password length

N

2

D-r1.0+

6

input time limit, normal

N

2

D-r1.0+

7

input time limit, full mailbox timeout

N

1

D-r1.0+

8

input time limit, wait

N

3

D-r1.0+

9

broadcast mailbox extension

K

10

D-r1.0+

10

system prime time, start hour

N

2

D-r1.0+

11

system prime time, start minute

N

2

D-r1.0+

12

system prime time, end hour

N

2

D-r1.0+

13

system prime time, end minute

N

2

D-r1.0+

14

traffic collection activation

L

1

D-r1.0+

15

name recording by subscriber activation

L

1

D-r1.0+

16

multiple personal greetings activation

L

1

D-r1.0+

17

call transfer out of AUDIX activation

L

1

D-r1.0+

18

enhanced call transfer activation

L

1

D-r1.0+

19

covering ext for call transfer out of AUDIX

K

10

D-r1.0+

20

call transfer restriction out of AUDIX

C

11

D-r1.0+

21

end of message warning feature activation

L

1

D-r1.0+

22

end of message warning time

N

2

D-r1.0+

23

weekly backup enabled

L

1

D-r1.0+

24

active announcement set

C

14

D-r1.0+

25

administrative announcement set

C

14

D-r1.0+

26

rescheduling increment 1, days

N

2

D-r1.0+

27

rescheduling increment 1, hours

N

2

D-r1.0+

28

rescheduling increment 1, minutes

N

2

D-r1.0+

29

rescheduling increment 2, days

N

2

D-r1.0+

30

rescheduling increment 2, hour

N

2

D-r1.0+

31

rescheduling increment 2, minutes

N

2

D-r1.0+

32

rescheduling increment 3, days

N

2

D-r1.0+

33

rescheduling increment 3, hours

N

2

D-r1.0+

34

rescheduling increment 3, minutes

N

2

D-r1.0+

35

rescheduling increment 4, days

N

2

D-r1.0+

36

rescheduling increment 4, hours

N

2

D-r1.0+

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysfe

12-155
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

37

rescheduling increment 4, minutes

N

2

D-r1.0+

38

rescheduling increment 5, days

N

2

D-r1.0+

39

rescheduling increment 5, hours

N

2

D-r1.0+

40

rescheduling increment 5, minutes

N

2

D-r1.0+

41

rescheduling increment 6, days

N

2

D-r1.0+

42

rescheduling increment 6, hours

N

2

D-r1.0+

43

rescheduling increment 6, minutes

N

2

D-r1.0+

44

rescheduling increment 7, days

N

2

D-r1.0+

45

rescheduling increment 7, hours

N

2

D-r1.0+

46

rescheduling increment 7, minutes

N

2

D-r1.0+

47

rescheduling increment 8, days

N

2

D-r1.0+

48

rescheduling increment 8, hours

N

2

D-r1.0+

49

rescheduling increment 8, minutes

N

2

D-r1.0+

50

rescheduling increment 9, days

N

2

D-r1.0+

51

rescheduling increment 9, hours

N

2

D-r1.0+

52

rescheduling increment 9, minutes

N

2

D-r1.0+

53

rescheduling increment 10, days

N

2

D-r1.0+

54

rescheduling increment 10, hours

N

2

D-r1.0+

55

rescheduling increment 10, minutes

N

2

D-r1.0+

56

call transfer type

C

19

D-r2.0+

57

rewind increment

C

1

D-r3.0+

58

advance increment

C

1

D-r3.0+

59

quick silence disconnect

L

1

D-r3.0+

60

silence limit

N

2

D-r3.0+

61

tone based disconnect

L

1

D-r3.0+

62

password expiration interval

N

3

D-r3.1+

63

minimum age before changes

N

2

D-r3.1+

64

expiration warning

N

2

D-r3.1+

65

auto attendant between digits

N

2

D-r3.1+

66

priority on call answer

L

1

D-r3.1+

67

weekly backup - locals only

L

1

D-r3.2+

68

admin login - expiration interval

N

3

D-r3.2+

69

admin login - minimum age

N

2

D-r3.2+

70

admin login - expiration warning

N

2

D-r3.2+

INTUITY
AUDIX
System

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysfe

12-156

Output Format
Output for the getsysfe command when communicating with an INTUITY AUDIX
system is formatted as follows.

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

switch connection type

C

11

I-r2.0+

2

login retries

N

1

I-r2.0+

3

consecutive invalid login attempts

N

3

I-r2.0+

4

system guest password

K

15

I-r2.0+

5

minimum password length

N

2

I-r2.0+

6

input time limit, normal

N

2

I-r2.0+

7

input time limit, full mailbox timeout

N

1

I-r2.0+

8

input time limit, wait

N

3

I-r2.0+

9

broadcast mailbox extension

K

10

I-r2.0+

10

system prime time, start hour

N

2

I-r2.0+

11

system prime time, start minute

N

2

I-r2.0+

12

system prime time, end hour

N

2

I-r2.0+

13

system prime time, end minute

N

2

I-r2.0+

14

traffic collection activation

L

1

I-r2.0+

15

name recording by subscriber activation

L

1

I-r2.0+

16

multiple personal greetings activation

L

1

I-r2.0+

17

call transfer out of AUDIX activation

L

1

I-r2.0+

18

enhanced call transfer activation

L

1

I-r2.0+

19

covering ext for call transfer out of AUDIX

K

10

I-r2.0+

20

call transfer restriction out of AUDIX

C

11

I-r2.0+

21

end of message warning feature activation

L

1

I-r2.0+

22

end of message warning time

N

2

I-r2.0+

23

weekly backup enabled

L

1

I-r2.0+

24

active announcement set

C

14

I-r2.0+

25

administrative announcement set

C

14

I-r2.0+

26

rescheduling increment 1, days

N

2

I-r2.0+

27

rescheduling increment 1, hours

N

2

I-r2.0+

28

rescheduling increment 1, minutes

N

2

I-r2.0+

29

rescheduling increment 2, days

N

2

I-r2.0+

30

rescheduling increment 2, hour

N

2

I-r2.0+

31

rescheduling increment 2, minutes

N

2

I-r2.0+

32

rescheduling increment 3, days

N

2

I-r2.0+

33

rescheduling increment 3, hours

N

2

I-r2.0+

34

rescheduling increment 3, minutes

N

2

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysfe

12-157
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

35

rescheduling increment 4, days

N

2

I-r2.0+

36

rescheduling increment 4, hours

N

2

I-r2.0+

37

rescheduling increment 4, minutes

N

2

I-r2.0+

38

rescheduling increment 5, days

N

2

I-r2.0+

39

rescheduling increment 5, hours

N

2

I-r2.0+

40

rescheduling increment 5, minutes

N

2

I-r2.0+

41

rescheduling increment 6, days

N

2

I-r2.0+

42

rescheduling increment 6, hours

N

2

I-r2.0+

43

rescheduling increment 6, minutes

N

2

I-r2.0+

44

rescheduling increment 7, days

N

2

I-r2.0+

45

rescheduling increment 7, hours

N

2

I-r2.0+

46

rescheduling increment 7, minutes

N

2

I-r2.0+

47

rescheduling increment 8, days

N

2

I-r2.0+

48

rescheduling increment 8, hours

N

2

I-r2.0+

49

rescheduling increment 8, minutes

N

2

I-r2.0+

50

rescheduling increment 9, days

N

2

I-r2.0+

51

rescheduling increment 9, hours

N

2

I-r2.0+

52

rescheduling increment 9, minutes

N

2

I-r2.0+

53

rescheduling increment 10, days

N

2

I-r2.0+

54

rescheduling increment 10, hours

N

2

I-r2.0+

55

rescheduling increment 10, minutes

N

2

I-r2.0+

56

call transfer type

C

19

I-r2.0+

57

rewind increment

C

1

I-r3.2+

58

advance increment

C

1

I-r3.2+

59

quick silence disconnect

L

1

I-r3.2+

60

silence limit

N

2

I-r3.2+

61

tone based disconnect

L

1

I-r3.2+

62

password expiration interval

N

3

I-r3.2+

63

minimum age before changes

N

2

I-r3.2+

64

expiration warning

N

2

I-r3.2+

65

auto attendant between digits

N

2

I-r3.2+

66

priority on call answer

L

1

I-r3.2+

67

call answer disable

L

1

I-r3.3+

68

address before record

L

1

I-r3.3+

69

called subscriber id

C

20

I-r3.3+

70

FAX print destination prefix

N

21

I-r3.3+

71

text to speech conversion

C

18

I-r4.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
getsysfe

12-158

Example
The following command retrieves the INTUITY or DEFINITY AUDIX Display System-Parameters Features screen data, writes a summary of the transfer statistics
to the screen, and writes output to a file named sysfeat.
getsysfe -v > sysfeat

RETURN

The following data is written to the file:
"embedded",3,18,"",0,50,180,5,"",11,00,02,00,"y","y",
"y","y","n","1000","subscribers","y",15,"y","standard",
"standard",0,0,5,0,0,15,0,0,30,0,1,0,0,2,0,0,6,0,1,0,0,
0,0,0,0,0,0,0,0,0,"enhanced","l","l","n",1,"y",50,6,5,
3,"y","y",50,6,5 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettlist

12-159

gettlist
Get remote text address list

Syntax
gettlist -m trusted server [-r release] [-v] [-w] [-V] [ > ofile]

Description
This command retrieves all pages of the following screens for the specified
machine:
■

INTUITY AUDIX List Remote-text-addresses

No input is required. Retrieved data is written to standard output.
-m

Remote trusted server flag; must be followed by trusted server.

trusted
server

Retrieves data for the specified remote trusted server. Use the
trusted server name that was entered on the administrator’s INTUITY
AUDIX System trusted server profile screen when the remote
trusted server was added to the network. If the trusted server name
is more than one word (such as "new york"), the name must be
enclosed in quotation marks.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX (I-r4.0
and beyond) System. The default for the INTUITY AUDIX System is
I-r5.0

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

> ofile

Specifies the name of the file to which data is written. The filename
must be preceded by the symbol >. If no output file is specified,
data is written to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettlist

12-160

Errors
If you try to use this command with an R1 AUDIX System or a DEFINITY AUDIX
System, an error message appears on the screen.

Output Format
Output for the gettlist command is formatted as follow, with one record for each
remote subscriber.

FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

1

text address

C

64

I-r4.0+

2

name

C

29

I-r4.0+

3

type

C

12

I-r4.0+

4

last usage date

D

8

I-r4.0+

Example
The following command retrieves the INTUITY AUDIX List remote-text-addresses
screen data for all INTUITY AUDIX System Remote Subscribers for the specified
remote trusted server (in this case seattle), writes a summary of the transfer statistics to the screen, and writes output to a file named rtext.
gettlist -m seattle -v > rtext

RETURN

The following data is written to the file, one line for each remote subscriber:
"drnote11.dr.att.com@drnote11","drnote11.dr.att.com",
"verified",19951129 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-161

gettraf
Get subscriber measurements

Syntax
gettraf -f day [-d mmddyy] [-n nn] [-r release] [-v] [-w] [-V] [-i] [< ifile] [> ofile]
or
gettraf -f month [-d mmyy] [-n nn] [-r release] [-v] [-w] [-V] [-i] [< ifile] [> ofile]

Description
This command retrieves the following screens for the month and subscriber that
you specify:
■

INTUITY AUDIX List Measurements Subscriber Month

■

DEFINITY AUDIX List Measurements Subscriber Month

■

R1 AUDIX traffic : subscriber : month

This command retrieves the following screens for the date and subscriber that
you specify:
■

INTUITY AUDIX List Measurements Subscriber Day

■

DEFINITY AUDIX List Measurements Subscriber Day

■

R1 AUDIX traffic : subscriber : day

Use subscriber extensions as input. Retrieved data is written to standard output.

-f

Screen flag; must be followed by either month or day.

month

Specifies month screen data.

day

Specifies day screen data.

-d

Date flag; must be followed by mmddyy for the day screen or
mmyy for the month screen. This flag is required for AUDIX
systems. If this flag is omitted, the most recent date’s data is
returned.

mmyy

Retrieves data for the month and year indicated by mmyy. For
example, if you enter 0794, the data for July 1994 is retrieved.

mmddyy

Retrieves data for the month, day, and year indicated by mmddyy.
For example, if you enter 072294, the data for July 22, 1994, is
retrieved.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-162

-n

Record number flag; must be followed by nn. This flag is available
only for the INTUITY and DEFINITY AUDIX system. If you don’t
include this flag, only one record (month or day) is returned.

nn

Retrieves the number (nn) of daily or monthly records that you
specify. For example, if you want to retrieve monthly data and you
enter 0394 for mmyy and then enter 3 for nn, the data for the
months between March and May 1994 (the data beginning on
March, 1994 and continuing through the next 3 months) will be
retrieved.
The same is true for daily records. If you enter 112294 for mmddyy
and then enter 8 for nn, the data from and including November 22,
1994, and continuing through November 29, 1994, is retrieved.
For the INTUITY or DEFINITY AUDIX System, if you may use the
value all to retrieve all records (month or day) on or after any
specified date and time.

-r

Release flag; must be followed by release.

release

Retrieves data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX System software The default for the
DEFINITY AUDIX System is D-r3.2. The default for the INTUITY
AUDIX System is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the extensions will be read.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-163

< ifile

Specifies the name of an input file you have created. The filename
must be preceded by the symbol <. This file contains one or more
extensions of the subscribers whose traffic data this command
retrieves. If you don’t specify an input file, you must specify the -i
option, which allows you to type the individual extensions directly
from your keyboard after entering this command.

> ofile

Specifies the name of the file to which data will be written. The
filename must be preceded by the symbol >. If no output file is
specified, data is written to the screen.

Errors
If the extension or subscriber name doesn’t represent a valid voice mail system
subscriber, an error message appears, giving the record number containing the
invalid extension and, if more records exist, retrieval continues.
If the specified date is invalid for an R1 AUDIX System, the retrieval aborts and
no records are written.
If the specified date is before any valid date for a INTUITY or DEFINITY AUDIX
System, the retrieval starts at the first date with data. If the specified date is after
a valid date, an error message is returned and the retrieval aborts.

Input Format
The Input Format consists of one record for each subscriber:
FIELD

Seq.
No.

Field Name

1

extension

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

K

10

r1v2+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-164

Output Format
Output for the gettraf command with the -f month option when communicating
with INTUITY AUDIX, DEFINITY AUDIX or R1 AUDIX (R1V3 and beyond) System is
formatted as follows, with one record for each subscriber specified by the input
file (or on the keyboard, if you use the -i option).
FIELD

Seq.
No.

Field Name

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

1

name

C

29

r1v3+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v3+

D-r1.0+

I-r2.0+

3

mailbox space used in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

4

space allowed in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

5

maximum space used in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

6

space guaranteed in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

7

prime CA sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

8

non-prime CA sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

prime VM sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

10

9

non-prime VM sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

11

prime CA session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

12

non-prime CA session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

13

prime VM session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

14

non-prime VM session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

15

prime CA messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

16

non-prime CA messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

17

prime local VM messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

18

non-prime local VM messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

19

prime remote VM messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

20

non-prime remote VM messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

21

prime local VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

22

non-prime local VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

23

prime remote VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

24

non-prime remote VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

25

prime CA text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

26

non-prime CA text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

27

prime VM text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

28

non-prime VM text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

29

community id

N

2

r1v5+

D-r1.0+

I-r2.0+

30

prime VM undeliverable notifications

N

10

r1v5+

D-r1.0+

I-r2.0+

31

non-prime VM undeliverable notifications

N

10

r1v5+

D-r1.0+

I-r2.0+

32

prime total VM messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

33

non-prime total VM messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

34

prime broadcast messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-165
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

N

10

r1v5+

D-r1.0+

I-r2.0+

prime log-in announcements created

N

10

r1v5+

D-r1.0+

I-r2.0+

non-prime log-in announcements created

N

10

r1v5+

D-r1.0+

I-r2.0+

38

prime priority messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

39

non-prime priority messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

40

prime private messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

41

non-prime private messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

42

starting date

D

8

D-r1.0+

I-r2.0+

43

ending date

D

8

D-r1.0+

I-r2.0+

44

local voice components received - prime

N

10

I-r5.0+

45

local voice components received - non-prime

N

10

I-r5.0+

46

local FAX components received - prime

N

10

I-r5.0+

47

local FAX components received - non-prime

N

10

I-r5.0+

48

local binary attachments received - prime

N

10

I-r5.0+

49

local binary attachments received - non-prime

N

10

I-r5.0+

50

local text components received - prime

N

10

I-r5.0+

51

local text components received - non-prime

N

10

I-r5.0+

52

remote voice components received - prime

N

10

I-r5.0+

53

remote voice components received - non-prime

N

10

I-r5.0+

54

remote FAX components received - prime

N

10

I-r5.0+

55

remote FAX components received - non-prime

N

10

I-r5.0+

56

remote binary attachments received - prime

N

10

I-r5.0+

57

remote binary attachments received - non-prime

N

10

I-r5.0+

58

remote text components received - prime

N

10

I-r5.0+

59

remote text components received - non-prime

N

10

I-r5.0+

Seq.
No.

Field Name

35

non-prime broadcast messages created

36
37

60

call answer voice components - prime

N

10

I-r5.0+

61

call answer voice components - non-prime

N

10

I-r5.0+

62

call answer FAX components - prime

N

10

I-r5.0+

63

call answer FAX components - non-prime

N

10

I-r5.0+

64

voice components created - prime

N

10

I-r5.0+

65

voice components created - non-prime

N

10

I-r5.0+

66

FAX components created - prime

N

10

I-r5.0+

67

FAX components created - non-prime

N

10

I-r5.0+

68

binary attachments created - prime

N

10

I-r5.0+

69

binary attachments created - non-prime

N

10

I-r5.0+

70

text components created - prime

N

10

I-r5.0+

71

text components created - non-prime

N

10

I-r5.0+

72

local voice components sent - prime

N

10

I-r5.0+

73

local voice components sent - non-prime

N

10

I-r5.0+

74

local FAX components sent - prime

N

10

I-r5.0+

75

local FAX components sent - non-prime

N

10

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-166
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

76

local binary attachments sent - prime

N

10

I-r5.0+

77

local binary attachments sent - non-prime

N

10

I-r5.0+

78

local text components sent - prime

N

10

I-r5.0+

79

local text components sent - non-prime

N

10

I-r5.0+

80

remote voice components sent - prime

N

10

I-r5.0+

81

remote voice components sent - non-prime

N

10

I-r5.0+

82

remote FAX components sent - prime

N

10

I-r5.0+

83

remote FAX components sent - non-prime

N

10

I-r5.0+

84

remote binary attachments sent - prime

N

10

I-r5.0+

85

remote binary attachments sent - non-prime

N

10

I-r5.0+

86

remote text components sent - prime

N

10

I-r5.0+

87

remote text components sent - non-prime

N

10

I-r5.0+

Output for the gettraf command with the -f day option when communicating with
INTUITY AUDIX, DEFINITY AUDIX or R1 AUDIX (R1V3 and beyond) system is
formatted as follows, with one record for each subscriber specified by the input
file (or on the keyboard, if you use the -i option).
FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v3+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v3+

D-r1.0+

I-r2.0+

3

mailbox space used in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

4

space allowed in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

5

maximum space used in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

6

space guaranteed in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

7

prime CA sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

8

non-prime CA sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

9

prime VM sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

10

non-prime VM sessions

N

10

r1v3+

D-r1.0+

I-r2.0+

11

prime CA session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

12

non-prime CA session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

13

prime VM session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

14

non-prime VM session usage in seconds

N

10

r1v3+

D-r1.0+

I-r2.0+

15

prime CA messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

16

non-prime CA messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

17

prime local VM messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

18

non-prime local VM messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

19

prime remote VM messages received

N

10

r1v3+

D-r1.0+

I-r2.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-167
FIELD

Seq.
No.

Field Name

20

non-prime remote VM messages received

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

N

10

r1v3+

D-r1.0+

I-r2.0+

21

prime local VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

22

non-prime local VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

23

prime remote VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

24

non-prime remote VM messages sent

N

10

r1v3+

D-r1.0+

I-r2.0+

25

prime CA text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

26

non-prime CA text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

27

prime VM text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

28

non-prime VM text service headers created

N

10

r1v4+

D-r1.0+

I-r2.0+

29

community id

N

2

r1v5+

D-r1.0+

I-r2.0+

30

prime VM undeliverable notifications

N

10

r1v5+

D-r1.0+

I-r2.0+

31

non-prime VM undeliverable notifications

N

10

r1v5+

D-r1.0+

I-r2.0+

32

prime total VM messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

33

non-prime total VM messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

34

prime broadcast messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

35

non-prime broadcast messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

36

prime log-in announcements created

N

10

r1v5+

D-r1.0+

I-r2.0+

37

non-prime log-in announcements created

N

10

r1v5+

D-r1.0+

I-r2.0+

38

prime priority messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

39

non-prime priority messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

40

prime private messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

41

non-prime private messages created

N

10

r1v5+

D-r1.0+

I-r2.0+

42

starting date

D

8

D-r1.0+

I-r2.0+

43

ending time

T

4

D-r1.0+

I-r2.0+

44

local voice components received - prime

N

10

I-r5.0+

45

local voice components received - non-prime

N

10

I-r5.0+

46

local FAX components received - prime

N

10

I-r5.0+

47

local FAX components received - non-prime

N

10

I-r5.0+

48

local binary attachments received - prime

N

10

I-r5.0+

49

local binary attachments received - non-prime

N

10

I-r5.0+

50

local text components received - prime

N

10

I-r5.0+

51

local text components received - non-prime

N

10

I-r5.0+

52

remote voice components received - prime

N

10

I-r5.0+

53

remote voice components received - non-prime

N

10

I-r5.0+

54

remote FAX components received - prime

N

10

I-r5.0+

55

remote FAX components received - non-prime

N

10

I-r5.0+

56

remote binary attachments received - prime

N

10

I-r5.0+

57

remote binary attachments received - non-prime

N

10

I-r5.0+

58

remote text components received - prime

N

10

I-r5.0+

59

remote text components received - non-prime

N

10

I-r5.0+

60

call answer voice components - prime

N

10

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-168
FIELD

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

Max.
Width

61

call answer voice components - non-prime

N

10

I-r5.0+

62

call answer FAX components - prime

N

10

I-r5.0+

63

call answer FAX components - non-prime

N

10

I-r5.0+

64

voice components created - prime

N

10

I-r5.0+

65

voice components created - non-prime

N

10

I-r5.0+

66

FAX components created - prime

N

10

I-r5.0+

67

FAX components created - non-prime

N

10

I-r5.0+

68

binary attachments created - prime

N

10

I-r5.0+

69

binary attachments created - non-prime

N

10

I-r5.0+

70

text components created - prime

N

10

I-r5.0+

71

text components created - non-prime

N

10

I-r5.0+

72

local voice components sent - prime

N

10

I-r5.0+

73

local voice components sent - non-prime

N

10

I-r5.0+

74

local FAX components sent - prime

N

10

I-r5.0+

75

local FAX components sent - non-prime

N

10

I-r5.0+

76

local binary attachments sent - prime

N

10

I-r5.0+

77

local binary attachments sent - non-prime

N

10

I-r5.0+

78

local text components sent - prime

N

10

I-r5.0+

79

local text components sent - non-prime

N

10

I-r5.0+

80

remote voice components sent - prime

N

10

I-r5.0+

81

remote voice components sent - non-prime

N

10

I-r5.0+

82

remote FAX components sent - prime

N

10

I-r5.0+

83

remote FAX components sent - non-prime

N

10

I-r5.0+

84

remote binary attachments sent - prime

N

10

I-r5.0+

85

remote binary attachments sent - non-prime

N

10

I-r5.0+

86

remote text components sent - prime

N

10

I-r5.0+

87

remote text components sent - non-prime

N

10

I-r5.0+

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-169

Output for the gettraf command with the -f day or the -f month option when
communicating with an AUDIX R1V2 System is formatted as follows, with one
record for each subscriber specified by the input file (or on the keyboard, if you
use the -i option).
FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

Field Name

Type

Max.
Width

1

name

C

29

r1v2

2

extension

K

10

r1v2

3

mailbox space used in seconds

N

8

r1v2

4

space allowed in seconds

N

8

r1v2

5

maximum space used in seconds

N

8

r1v2

6

space guaranteed in seconds

N

8

r1v2

7

prime CA sessions

N

10

r1v2

8

non-prime CA sessions

N

10

r1v2

9

prime VM sessions

N

10

r1v2

10

non-prime VM sessions

N

10

r1v2

11

prime CA session usage in seconds

N

10

r1v2

12

non-prime CA session usage in seconds

N

10

r1v2

13

prime VM session usage in seconds

N

10

r1v2

14

non-prime VM session usage in seconds

N

10

r1v2

15

prime CA messages received

N

10

r1v2

16

non-prime CA messages received

N

10

r1v2

17

prime VM messages received

N

10

r1v2

18

non-prime VM messages received

N

10

r1v2

19

prime VM messages sent

N

10

r1v2

20

non-prime VM messages sent

N

10

r1v2

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Example
The following command retrieves the INTUITY or DEFINITY AUDIX List Measurements Subscriber Day data for September 27, 1994, for all of the INTUITY or
DEFINITY AUDIX system subscribers in Department 27 and writes output to a file
named trafd27:
gettraf -f day -d 092794 < subs.d27 > trafd27

RETURN

The number of records in the output file will be the same as the number of
subscriber extensions input to the gettraf command.
The following data is written to the file:
"Doe,John","56789",296,1200,312,0,0,0,2,0,0,0,66,0,0,0,
1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,
19940927,2359 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

12 Command Line Database Retrieval Commands
gettraf

12-170

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
Overview

13-1

Command Line Database
Modification Commands

13

Overview
For each of the following retrieval commands, this chapter provides the syntax, a
description, errors, output format, and an example.

addrsub

changsw

addsub

changtex

changcex

chgrcom

changcom

chgrext

changcos

chgrmach

changext

chgrnam

changmis

delrsub

changmsg

delsub

changnam

setadj

changpwd

setalogp

changsub

setscdr

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
addrsub

13-2

addrsub
Add remote subscriber

Syntax
addrsub [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command adds subscribers to the current database of the voice mail
system. Use the name, extension, machine, and community ID as input for each
subscriber. Command statistics are written to standard output.

-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX (R1V3 and beyond) System software. For the
DEFINITY AUDIX System the default is D-r3.2. For the INTUITY AUDIX
System the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be added. Each
record includes name, extension, machine, and community ID. If you
don’t specify an input file, you must type each name, extension,
machine, and community ID directly from your keyboard after
entering this command.

> ofile

Name of the file to which command statistics are written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
addrsub

13-3

Input Format
The input consists of one record for each subscriber, formatted as follows:.

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v3+

D-r1.0+

I-r2.0+

2

extension/text address

C

64

r1v3+

D-r1.0+

I-r2.0+

3

machine/trusted server name

C

10

r1v3+

D-r1.0+

I-r2.0+

4

[community id]

N

2

r1v3+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
REMOTE SUBSCRIBER ADD ROUTINE ( )
name = ___________; extension/text address = __________;
machine/trusted server name = ______; community id = ____;
____: ADDED REMOTE SUB __________

Example
The following command adds one remote subscriber to the subscriber database.
addrsub -i

RETURN

"Doe, John","74199","denver","1"

RETURN

The following data appears on the screen:
REMOTE SUBSCRIBER ADD ROUTINE ( )
name = Doe, John; extension/text address = 74199;
machine/trusted server name = denver;
community id = 1;
1: ADDED REMOTE SUB 74199 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
addsub

13-4

addsub
Add subscriber

Syntax
addsub [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
Adds subscribers to the current database of the voice mail system. Use the
name, extension, password, class of service, switch number, and community ID
as input for each subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the voice mail software. For
the DEFINITY AUDIX System the default is D-r3.2. For the INTUITY
AUDIX System the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the command exit status to the file,
main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file
(< ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. Filename must be preceded
by <.
This file contains the subscriber records to be added. Each record
includes name, extension, password, class of service, switch
number, and community ID. If you don’t specify an input file, you
must type each name, extension, password, class of service, switch
number, and community ID directly from your keyboard after
entering this command.

> ofile

Specifies the file where command statistics are written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
addsub

13-5

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows.
FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

password

C

15

r1v2+

D-r1.0+

I-r2.0+

4

[class of service]

K

8

r1v2+

D-r1.0+

I-r2.0+

5

[switch number]

N

2

r1v2+

D-r1.0+

I-r2.0+

6

[community id]

N

2

r1v2+

D-r1.0+

I-r2.0+

When connected to an R1 AUDIX system, you cannot enter a custom class of
service while using this command. If a new subscriber requires a custom class of
service, first enter a regular class of service; then alter the subscriber record later
on the administration terminal or with another database modification command.
When connected to a INTUITY or DEFINITY AUDIX system, you may use the value
custom for the class of service. The service attribute values for class of service 0
are used, but the subscriber’s class of service are not associated with class of
service 0 (i.e. if class of service 0 changes, the subscriber’s class of service
does not change).

Output Format
The output for each record consists of the command statistics as follows
SUBSCRIBER ADD ROUTINE ()
name = __________; extension = _______; password = ____;
cos = ____; switch number = ________;
community id = _______________;
____: ADDED EXT __________

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
addsub

13-6

Example
The following command adds one subscriber to the subscriber database.
addsub -i

RETURN

"Doe, John","3501","0","0","0","1"

RETURN

The following data appears on the screen:
SUBSCRIBER ADD ROUTINE ( )
"Doe, John","3501","0","0","0","1"
name = Doe, John; extension = 3501; password = 0; cos = 0;
switch number = 0; community id = 1;
1: ADDED EXT 3501 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changcex

13-7

changcex
Change subscriber covering extension

Syntax
changcex [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber covering extensions in the current database
of the voice mail system. Use the name, extension, and new covering extension
as input for each subscriber. Command statistics are written to standard output.

-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX System software. For the DEFINITY AUDIX
System, the default is D-r3.2. For the INTUITY AUDIX System, the
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file
(< ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record includes name, extension, and covering extension. You
can edit the output of the getlist command to generate input to this
command. If you don’t specify an input file, you must type each
name, extension, and covering extension directly from your
keyboard after entering this command.

> ofile

Name of the file to which command statistics are written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changcex

13-8

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist in the input, database modification
continues with the next input record.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

new covering extension

K

10

r1v2+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE COVERING EXTENSION ROUTINE ( )
name = ___________; extension = _______;
new covering ext. = _______;
____: CHANGED COVERING EXT __________

Example
The following command modifies one subscriber in the subscriber database.
changcex -i

RETURN

"Martinez, Bob","73101"","73102"

RETURN

The following data appears on the screen:
CHANGE COVERING EXTENSION ROUTINE ( )
"Martinez, Bob","73101","73102"
name = Martinez, Bob; extension = 73102;
new covering ext. = 73102;
1: CHANGED COVERING EXT 73102 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changcom

13-9

changcom
Change subscriber community ID

Syntax
changcom [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber community IDs in the current database of the
voice mail system. Use the name, extension, and new community ID as input for
each subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX or AUDIX (R1V5 and beyond) System software. For the
DEFINITY AUDIX System, the default is D-r3.2. For the INTUITY AUDIX
System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q (quit)
options. Otherwise, if you type ahead, you may lose characters.
If you don’t specify -i, you must specify an input file (< ifile) from which
the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified. Each
record contains a name, extension, and community ID. You can edit
the output of the getlist command to generate input to this command.
If you don’t specify an input file, type each name, extension, and
community ID directly from your keyboard after entering this command.

> ofile

Specifies the file to which command statistics are written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changcom

13-10

Errors
If either the name or extension does not belong to a valid system subscriber, an
error message displays on the screen. If more records exist, database
modification continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v5+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v5+

D-r1.0+

I-r2.0+

3

new community id

C

2

r1v5+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE COMMUNITY ID ROUTINE ( )
name___________; extension = ________;
new community id = _____;
____: CHANGED COMMUNITY ID__________

Example
The following command modifies one subscriber in the subscriber database.
changcom -i

RETURN

"Doe, John","73101","3"

RETURN

The following data appears on the screen:
CHANGE COMMUNITY ID ROUTINE ( )
"Doe, John","73101","3"
name = Doe, John; extension = 73101;
new community id = 3;
5: CHANGED COMMUNITY ID 3 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changcos

13-11

changcos
Change subscriber class of service

Syntax
changcos [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber classes of service in the current database of
the voice mail system. Use the name, extension, and new class of service as
input for each subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX System software. For the DEFINITY AUDIX
System, the default is D-r3.2. For the INTUITY AUDIX System, the
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file (<
ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record contains a name, extension, and class of service. You
can edit the output of the getlist command to generate input to this
command. If you don’t specify an input file, type each name,
extension, and class of service directly from your keyboard after
entering this command.

> ofile

Specifies the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changcos

13-12

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist, database modification continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

new class of service

C

8

r1v2+

D-r1.0+

I-r2.0+

You may use the value custom for the class of service. The subscriber’s current
class of service parameters are retained, but the subscriber’s class of service is
not associated with the original (or any) class of service thereafter (i.e. if the
original class of service changes, the subscriber’s attributes do not change).

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE COS ROUTINE ( )
name = __________; extension = ________; new cos = _______;
____: CHANGED COS__________

Example
The following command modifies one subscriber in the subscriber database.
changcos -i

RETURN

"Brown, Jane", "73101", "3"

RETURN

The following data appears on the screen:
CHANGE COS ROUTINE ( )
"Brown, Jane","73101","3"
name = Brown, Jane; extension = 73101; new cos = 3;
1:

CHANGED COS 3

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changext

13-13

changext
Change subscriber extension

Syntax
changext [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber extensions in the current database of the
voice mail system. Use the name, old extension, and new extension as input for
each subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX System software. For the DEFINITY AUDIX
System, the default is D-r3.2. For the INTUITY AUDIX System, the
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file (<
ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record includes name, old extension, and new extension. You
can edit the output of the getlist command to generate input to this
command. If you don’t specify an input file, type each name, old
extension, and new extension directly from your keyboard after
entering this command.

> ofile

Name of the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changext

13-14

Errors
If either the name or old extension doesn’t belong to a valid system subscriber,
an error message displays. If more records exist, database modification
continues. Since no duplicates for extensions are allowed, make sure you order
the file correctly.

Input Format
The Input Format consists of one record for each subscriber formatted as follows:

FIELD

Seq.
No.

VOICE MAIL VERSIONS

R1
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System
I-r2.0+

Field Name

Type

Max.
Width

1

name

C

29

r1v2+

D-r1.0+

2

old extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

new extension

K

10

r1v2+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE EXTENSION ROUTINE ( )
name = __________; extension = ________;
new extension = _____;
____: CHANGED EXT__________

Example
The following command modifies one subscriber in the subscriber database.
changext -i

RETURN

"Doe, John","73101","73199"

RETURN

The following data appears on the screen:
CHANGE EXTENSION ROUTINE ( )
"Doe, John","73101","73199"
name = Doe, John; extension = 73101; new extension = 73199;
1: CHANGED EXT 73199 (NEW)

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changmis

13-15

changmis
Change subscriber miscellaneous field

Syntax
changmis [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber miscellaneous fields in the current database
of the voice mail system. Use the name, extension, and miscellaneous fields for
each subscriber as input. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX System software. For the DEFINITY AUDIX
System, the default is D-r3.2. For the INTUITY AUDIX System, the
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file (<
ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more of the subscriber records to be
modified. Each record contains name, extension, and miscellaneous
field. You can edit the output of the getlist command to generate
input to this command. If you don’t specify an input file, you must
type each name, extension, and miscellaneous field directly from
your keyboard after entering this command.

> ofile

Name of the file where command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changmis

13-16

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist, database modification continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

new misc 1

C

11

r1v2+

D-r1.0+

I-r2.0+

4

new misc 2

C

11

I-r5.0+

5

new misc 3

C

11

I-r5.0+

6

new misc 4

C

11

I-r5.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE MISCELLANEOUS ROUTINE ( )
name = _________; extension = ________; new misc 1 = ______;
new misc 2 = _______; new misc 3 = _______;
new misc 4 = _______;
____: CHANGED MISCELLANEOUS__________

Example
The following command modifies one subscriber in the subscriber database.
changmis -i

RETURN

"Green, Sarah", "73101", "N45j2", "misc 2", "misc 3", "misc 4"

RETURN

The following data appears on the screen:
CHANGE MISCELLANEOUS ROUTINE ( )
"Green, Sarah","73101","N45j2","misc 2","misc 3","misc 4"
name = Green, Sarah; extension = 73101; new misc 1 = N45j2;
new misc 2 = misc 2; new misc 3 = misc 3;
new misc 4 = misc 4;
1: CHANGED MISCELLANEOUS N45j2 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changmis

13-17

With the ADAP4.1 (and prior) software and with the R1V8-3.1 (and prior)
software, only one miscellaneous field is available. So, in order to set that field,
the input file should contain one or more lines similar to the following:
"name","extension","misc"
Also, in order to clear the miscellaneous field, the input file should contain one or
more lines similar to the following:
"name","extension",""
With the ADAP5.0 (and beyond) software, two cases are possible: INTUITY AUDIX
systems I-r4.0 (and prior); and INTUITY AUDIX systems I-r5.0 (and beyond). For
the first case, in order to set the miscellaneous field, the input file should contain
one or more lines similar to the following:
"name","extension","misc","","",""
Also, in order to clear the miscellaneous field, the input file should contain one or
more lines similar to the following:
"name","extension","","","",""
For the second case, in order to set any or all of the four miscellaneous fields, the
input file should contain one or more lines similar to the following:
"name","extension","misc1","misc2","misc3","misc4"
Also, in order to clear all four of the miscellaneous fields, the input file should
contain one or more lines similar to the following:
"name","extension","","","",""
Finally, in order to set some of the miscellaneous fields and clear others, the input
file should contain one or more lines similar to the following:
"name","extension","misc1","","misc3",""

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changmsg

13-18

changmsg
Change subscriber priority message

Syntax
changmsg [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies the subscriber priority message field in the current
database of the voice mail system. Use the name, extension, and y or n as input
for each subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX (R1V5 and beyond) System software. For the
DEFINITY AUDIX System, the default is D-r3.2. For the INTUITY
AUDIX System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, main.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file
(< ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record contains name, extension, and priority message
activate/deactivate indicator (y or n). You can edit the output of the
getlist command to generate input to this command. If you don’t
specify an input file, you must type each name, extension, and
priority message indicator directly from your keyboard after
entering this command.

> ofile

Name of the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changmsg

13-19

Errors
If either the name or extension does not belong to a valid system subscriber, an
error message displays. If more records exist, database modification continues.

Input Format
The Input Format consists of one record for each subscriber.

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v5+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v5+

D-r1.0+

I-r2.0+

3

priority message indicator

L

1

r1v5+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE PRIORITY MESSAGE ROUTINE ( )
name = ________; extension = _______;
new priority message indicator = _______;
____: CHANGED PRIORITY MESSAGE__________

Example
The following command modifies one subscriber in the subscriber database.
changmsg -i

RETURN

"Doe, John","73101","n"

RETURN

The following data appears on the screen:
CHANGE PRIORITY MESSAGE ROUTINE ( )
"Doe, John","73101","n"
name = Doe, John; extension = 73101;
new priority message indicator = n;
1: CHANGED PRIORITY MESSAGE NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changnam

13-20

changnam
Change subscriber name

Syntax
changnam [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber names in the current database of the voice
mail system. Use the name, extension, and new name as input for each
subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX System software. For the DEFINITY AUDIX
System, the default is D-r3.2. For the INTUITY AUDIX System, the
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file (<
ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record contains a name, extension, and new name. You can
edit the output of the getlist command to generate input to this
command. If you don’t specify an input file, you must type each
name, extension, and new name directly from your keyboard after
entering this command.

> ofile

Specifies the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changnam

13-21

Errors
If either the old name or extension doesn’t belong to a valid system subscriber,
an error message displays. If more records exist, database modification
continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

Seq.
No.

VOICE MAIL VERSIONS
R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

Max.
Width

1

old name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

new name

C

29

r1v2+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE SUBSCRIBER NAME ROUTINE ( )
name = _________; extension = ________;
new name = _______________;
____: CHANGED NAME__________

Example
The following command modifies one subscriber in the subscriber database.
changnam -i

RETURN

"Doe, Mary", "73101", "Smith, Mary"

RETURN

The following data appears on the screen:
CHANGE SUBSCRIBER NAME ROUTINE ( )
"Doe, Mary","73101","Smith, Mary"
name = Doe, Mary; extension = 73101; new name = Smith, Mary;
1:

CHANGED NAME Smith, Mary

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changpwd

13-22

changpwd
Change subscriber password

Syntax
changpwd [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber passwords in the current database of the
voice mail system. Use the name, extension, and new password as input for
each subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX System software. For the DEFINITY AUDIX
System, the default is D-r3.2. For the INTUITY AUDIX System, the
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, main.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file
(< ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record includes name, extension, and password. You can
edit the output of the getlist command to generate input to this
command. If you don’t specify an input file, you must type each
name, extension, and password directly from your keyboard after
entering this command.

> ofile

Specifies the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changpwd

13-23

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist, database modification continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

new password

C

15

r1v2+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE PASSWORD ROUTINE ( )
name = _________; extension = ________;
new password = _______;
____: CHANGED PASSWORD__________

Example
The following command modifies one subscriber in the subscriber database.
changpwd -i

RETURN

"Doe, John", "73101", "565656"

RETURN

The following data appears on the screen:
CHANGE PASSWORD ROUTINE ( )
"Doe, John","73101","565656"
name = Doe, John; extension = 73101; new password = 565656;
1:

CHANGED PASSWORD 565656

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changsub

13-24

changsub
Change subscriber attributes

Syntax
changsub [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber attributes in the current database of the
INTUITY AUDIX, DEFINITY AUDIX, or R1 AUDIX systems. Use the subscriber
attributes in the order described in this manual page as input for each
subscriber. The subscriber must exist on the voice mail machine before using
this command.
Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX (R1V5 and beyond) System software. For the
DEFINITY AUDIX System, the default is D-r3.2. For the INTUITY
AUDIX System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, main.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns on interactive data input mode. Turns off the search for
possible subsequent entry of the v (verbose) and q (quit) options. If
you don’t specify -i, you must specify an input file (< ifile) from
which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record includes the attributes of the subscriber to be added. If
you don’t specify an input file, you must type the subscriber
attributes directly from your keyboard after entering this command.

> ofile

Specifies the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changsub

13-25

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist in the input file ( )

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changsub

13-28

If the program is successful in parsing the input record, it echoes the values it
sees for each of the fields. In interacting with all voice mail releases, the output
for each input record consists of the command statistics as follows:
name = _________; extension = ____; cos = _______;
password = _____; switch number = __; misc = _______; covering ext = _____;
addressing format = _; CA permissions = _; announcement ctrl = _;
outcalling = _; text service machine = ______; user id = ________________;
incoming lifo/fifo = _; incoming category order = ___;
new retention time = ____; old retention time = ____;
unopened retention time = ____; outgoing lifo/fifo = _;
outgoing category order = ____; file cabinet retention time = ____;
del/nondel retention time = ____; max VM message length = ____;
min VM space needed = ____; max CA message length = ____;
min CA space needed = ____; max mailing lists = ____;
max total list entries = _____; max mailbox size = ____;
min guaranteed space = ____; new name = __________; new extension = ____;
locked = _; community id = ___; broadcast mailbox = _; priority msgs = _;
broadcast permissions = _; warning time = _;

If communicating with a DEFINITY AUDIX System, the following additional
command statistics appear in the output for each input record. These items
appear after the above items.
CA language choice = _; login annc set = ________ ;
CA primary annc set = _____; CA secondary annc set = ______ ;
IMAPI access = _____; IMAPI voice file transfer = ______;
The INTUITY AUDIX System includes the following additional items:
CA language choice = _; login annc set = ________ ;
CA primary annc set = _____; CA secondary annc set = ______ ;
IMAPI access = _____; IMAPI message transfer = ________;
secondary extension = ______; FAX creation = __;
trusted server access = __;
Next, the program relays the input record to the voice mail machine and attempts
the change operation. If the transaction with the voice mail machine was not
successful, the program passes along the error message received from the voice
mail system. If the transaction was successful, the output shows (reflecting new
extension, if changed):
___: CHANGED EXT __________
The first blank of the above is replaced with the line number of the processed
input record. The second blank holds the extension number of the subscriber
modified. If the string CHANGED EXT followed by a space and the desired
extension does not appear in the output, the operation has failed.
Upon termination, the program prints a summary of the number of subscribers
successfully modified:
 subscribers changed

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changsub

13-29

If the number printed does not match the number of input records, one or more of
the requested change operations has failed.

Example
The following command changes two subscribers on a DEFINITY AUDIX System:

changsub -r D-r3.2 < sub.dat

RETURN

where sub.dat contains:
"Mozart, Wolfgang A","5803","heavy10" NEWLINE
"Bach, Johann S","5804","","","","","","","","", "y","","","f","","","
30" NEWLINE

The following data appears on standard output:
SUBSCRIBER CHANGE ROUTINE ( )
name = Mozart, Wolfgang A; extension = 5803; cos = heavy10;
password = ; switch number = ; misc = ; covering ext = ;
addressing format = ; CA permissions = ; announcement ctrl = ;
outcalling = ; text service machine = ; user id = ;
incoming lifo/fifo = ; incoming category order = ;
new retention time = ; old retention time = ;
unopened retention time = ; outgoing lifo/fifo = ;
outgoing category order = ; file cabinet retention time = ;
del/nondel retention time = ; max VM message length = ;
min VM space needed = ; max CA message length = ;
min CA space needed = ; max mailing lists = ;
max total list entries = ; max mailbox size = ; min guaranteed space = ;
new name = ; new extension = ; locked = ; community id = ;
broadcast mailbox = ; priority msgs = ; broadcast permissions = ;
warning time = ; CA language choice = ; login annc set = ;
CA primary annc set = ; CA secondary annc set = ; IMAPI access = ;
IMAPI voice file transfer = ;
1: CHANGED EXT 5083
name = Bach, Johann S; extension = 5804; cos = ; password = ;
switch number = ; misc = ; covering ext = ; addressing format = ;
CA permissions = ; announcement ctrl = ; outcalling = y ;
text service machine = ; user id = ; incoming lifo/fifo = fifo;
incoming category order = ; new retention time = ;
old retention time = 30; unopened retention time = ;
outgoing lifo/fifo = ; outgoing category order = ;
file cabinet retention time = ; del/nondel retention time = ;
max VM message length = ; min VM space needed = ;
max CA message length = ; min CA space needed = ;
max mailing lists = ; max total list entries = ; max mailbox size = ;
min guaranteed space = ; new name = ; new extension = ; locked = ;
community id = ; broadcast mailbox = ; priority msgs = ;
broadcast permissions = ; warning time = ;
CA language choice = ; login annc set = ; CA primary annc set = ;
CA secondary annc set = ; IMAPI access = ; IMAPI voice file transfer = ;

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changsub

13-30

2: CHANGED EXT 5084 2 subscriber(s) changed

In this example the execution of changsub has changed Mozart’s class of
service to heavy10 from whatever it was before. All attributes controlled by the
class of service are changed to the values associated with the class of service
named heavy10.
Bach may now use the outcalling feature, his incoming messages are now
ordered as first-in, first-out, and his old messages are now retained for 30 days.
These changes overwrite the values Bach previously had. The AUDIX System
automatically changes Bach’s class of service field to custom if these values
differ from the attributes of a named class of service that he had before running
changsub. Note that for Bach’s input record, many character string fields were
skipped and there is a new retention time numeric field.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changsw

13-31

changsw
Change subscriber switch number

Syntax
changsw [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies subscriber switch numbers in the current database of
the voice mail system. Use the name, extension, and new switch number for
each subscriber as input. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX , DEFINITY
AUDIX , or R1 AUDIX System software. For the DEFINITY AUDIX
System, the default is D-r3.2. For the INTUITY AUDIX System, the
default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, main.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record includes name, extension, and switch number. You
can edit the output of the getlist command to generate input to this
command. If you don’t specify an input file, you must type each
name, extension, and switch number directly from your keyboard
after entering this command.

> ofile

Name of the file where command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changsw

13-32

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist, database modification continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Seq.
No.

Field Name

Type

1

name

C

29

r1v2+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v2+

D-r1.0+

I-r2.0+

3

new switch number

N

2

r1v2+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE SWITCH ROUTINE ( )
name = _________; extension = _______;
new switch number = _______;
____: CHANGED SWITCH__________

Example
The following command modifies one subscriber in the subscriber database.
changsw -i

RETURN

"Doe, Mary", "73101", "2"

RETURN

The following data appears on the screen:
CHANGE SWITCH ROUTINE ( )
"Doe, Mary","73101","2"
name = Doe, Mary; extension = 73101; new switch number = 2;
1:

CHANGED SWITCH 2

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changtex

13-33

changtex
Change subscriber text-service machine and user identifier

Syntax
changtex -r release [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies R1 AUDIX system subscriber text-service machines and
user identifiers in the current database of the R1 AUDIX System. Use the name,
extension, new text-service machine, and new user identifier as input for each
subscriber. Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the R1 AUDIX System (R1V4
and beyond) software.The default is D-r3.2.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record contains name, extension, text service machine, and
user identifier. You can edit the output of the getlist command to
generate input to this command. If you don’t specify an input file,
you must type each name, extension, text service machine, and
user identifier directly from your keyboard after entering this
command.

> ofile

Name of the file where command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changtex

13-34

Errors
If either the name or extension does not belong to a valid R1 AUDIX System
subscriber, an error message displays. If more records exist, database
modification continues.
If you try to use this command with INTUITY or DEFINITY AUDIX Systems, an error
message displays on the screen.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

C

29

r1v4+

extension

K

10

r1v4+

3

new text service machine

C

10

r1v4+

4

new user id

C

30

r1v4+

Seq.
No.

Field Name

1

name

2

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE TEXT SERVICE MACHINE/USER ID ROUTINE ( )
name = _______; extension = _______;
new text service machine = ________; new user id = ______;
____: CHANGED TEXT SERVICE MACHINE______________
/USER ID__________

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
changtex

13-35

Example
The following command modifies one subscriber in the subscriber database.
changtex -r r1v6 -i

RETURN

"Jones, David", "34543", "lab2", "dvj"

RETURN

The following data appears on the screen:
CHANGE TEXT SERVICE MACHINE/USER ID ROUTINE ( )
name = Jones, David; ext = 34543;
new text service machine = lab2; new user id = dvj;
1:
NEWLINE

CHANGED TEXT SERVICE MACHINE lab2/USER ID dvj

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrcom

13-36

chgrcom
Change remote subscriber community ID

Syntax
chgrcom [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies remote subscriber community IDs in the current
database of the voice mail system. Use the name, extension, and new
community ID for each subscriber as input. Command statistics are written to
standard output.

-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX (R1V5 and beyond) System software. For the
DEFINITY AUDIX System the default is D-r3.2. For the INTUITY AUDIX
System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q (quit)
options. Otherwise, if you type ahead, you may lose characters.
If you don’t specify -i, you must specify an input file (< ifile) from which
the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified. Each
record contains a name, extension, and community ID. You can edit the
output of the getrlist command to generate input to this command. If
you don’t specify an input file, you must type each name, extension,
and community ID directly from your keyboard after entering this
command.

> ofile

Name of the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrcom

13-37

Errors
If either the name or extension does not belong to a valid system subscriber, an
error message displays. If more records exist, database modification continue.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

C

29

r1v5+

D-r1.0+

I-r2.0+

extension/text address

C

64

r1v5+

D-r1.0+

I-r2.0+

new community id

N

2

r1v5+

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

1

name

2
3

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE REMOTE COMMUNITY ID ROUTINE ( )
name = _________; extension/text address = _______;
new community id = __;
___: CHANGED COMMUNITY ID__________

Example
The following command modifies one remote subscriber in the subscriber
database.
chgrcom -i

RETURN

"Smith, David", "74101", "3"

RETURN

The following data appears on the screen:
CHANGE REMOTE COMMUNITY ID ROUTINE ( )
"Smith, David","74101","3"
name = Smith, David; extension/text address = 74101;
new community id = 3;
1:

CHANGED COMMUNITY ID 3

NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrext

13-38

chgrext
Change remote subscriber extensions

Syntax
chgrext [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies remote subscriber extensions in the current database of
the voice mail system.
Use the name, old extension, and new extension for each subscriber as input.
Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY , DEFINITY AUDIX or
R1 AUDIX (R1V3 and beyond) System software. For the DEFINITY
AUDIX System, the default is D-r3.2. For the INTUITY AUDIX System,
the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record contains name, old extension, and new extension. You
can edit the output of the getrlist command to generate input to this
command. If you don’t specify an input file, you must type each
name, old extension, and new extension directly from your keyboard
after entering this command.

> ofile

Specifies the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrext

13-39

Errors
If either the name or old extension doesn’t belong to a valid system subscriber,
an error message displays. If more records exist, database modification
continues. Since no duplicates for extensions are allowed, make sure you order
the file correctly.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:
FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

C

29

r1v3+

D-r1.0+

I-r2.0+

old extension

K

10

r1v3+

D-r1.0+

I-r2.0+

new extension

K

10

r1v3+

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

1

name

2
3

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE REMOTE EXTENSION ROUTINE ( )
name = _________; extension = _______;
new extension = _________;
____: CHANGED EXTENSION__________

Example
The following command modifies one remote subscriber in the subscriber
database.
chgrext -i

RETURN

"Smith, Alice", "74101", "74229"

RETURN

The following data appears on the screen:
CHANGE REMOTE EXTENSION ROUTINE ( )
"Smith, Alice","74101","74299"
name = Smith, Alice; extension = 74101;
new extension = 74299;
1: CHANGED EXT 74299 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrmach

13-40

chgrmach
Change remote subscriber machines

Syntax
chgrmach [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies the remote subscriber system (machine) (and optionally
the extension) in the current database of the voice mail system. Use the name,
extension, machine, and new extension as input for each subscriber. Command
statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX (R1V3 and beyond) System software. For the
DEFINITY AUDIX System, the default is D-r3.2. For the INTUITY
AUDIX System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into
the file, main.rc.

-V

Writes the ADAP version number for this command and exits
without transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file
(< ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record contains a name, old extension, machine, and new
extension. You can edit the output of the getrlist command to
generate input to this command. If you don’t specify an input file,
you must type each name, old extension, machine, and new
extension directly from your keyboard after entering this command.

> ofile

Name of the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrmach

13-41

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist, database modification continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows. The "new extension" portion of the input is optional.

FIELD

Seq.
No.

VOICE MAIL VERSIONS

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Field Name

Type

1

name

C

29

r1v3+

D-r1.0+

I-r2.0+

2

extension

K

10

r1v3+

D-r1.0+

I-r2.0+

3

new machine

C

10

r1v3+

D-r1.0+

I-r2.0+

4

[new extension]

K

10

r1v3+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE REMOTE MACHINE ROUTINE ( )
name = ________; extension = ______; new machine = _____;
new extension = _____;
____: CHANGED MACHINE__________

Example
The following command modifies one remote subscriber in the subscriber
database.
chgrmach -i

RETURN

"James, Jan", "74199", "omaha","76199"

RETURN

The following data appears on the screen:
CHANGE REMOTE MACHINE ROUTINE ( )
"James, Jan","74199","omaha","76199"
name = James, Jan; extension = 74199; new machine = omaha;
new extension = 76199;
1: CHANGED MACHINE omaha NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrnam

13-42

chgrnam
Change remote subscriber names

Syntax
chgrnam [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command modifies remote subscriber names in the current database of the
voice mail system. Use the name, extension, and new name as input for each
subscriber. Command statistics are written to standard output.

-r

Release flag; must be followed by release.

release

Sets data for the specified release of the INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX (R1V3 and beyond) System software. For the
DEFINITY AUDIX System, the default is D-r3.2. For the INTUITY
AUDIX System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be modified.
Each record contains a name, extension, and new name. You can
edit the output of the getrlist command to generate input to this
command. If you don’t specify an input file, you must type each
name, extension, and new name directly from your keyboard after
entering this command.

> ofile

Name of the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
chgrnam

13-43

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist, database modification continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:

FIELD

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

C

29

r1v3+

D-r1.0+

I-r2.0+

extension/text address

C

64

r1v3+

D-r1.0+

I-r2.0+

new name

C

29

r1v3+

D-r1.0+

I-r2.0+

Seq.
No.

Field Name

1

old name

2
3

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

Output Format
The Output Format for each record consists of the command statistics as follows:
CHANGE REMOTE SUBSCRIBER NAME ROUTINE ( )
name = _____________; extension/text address = ___________;
new name = ___________________;
__: CHANGED NAME___________

Example
The following command modifies one remote subscriber in the subscriber
database.
chgrnam -i

RETURN

"Hobbs, Ellen","74199","Smith, Ellen"

RETURN

The following data appears on the screen:
CHANGE REMOTE SUBSCRIBER NAME ROUTINE ( )
"Hobbs, Ellen","74199","Smith, Ellen"
name = Hobbs, Ellen; extension/text address = 74199;
new name = Smith, Ellen;
1: CHANGED NAME Smith, Ellen NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
delrsub

13-44

delrsub
Delete remote subscribers

Syntax
delrsub [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command deletes remote subscribers from the current database of the
voice mail system. Use the name and extension as input for each subscriber.
Command statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Deletes data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX (R1V3 and beyond) System
software. For the DEFINITY AUDIX System, the default is D-r3.2. For
the INTUITY AUDIX System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated
transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters.
If you don’t specify -i, you must specify an input file (< ifile) from
which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be deleted.
Each record contains a name and extension. You can use the output
of the getlist command as a starting point for input to this
command. If you don’t specify an input file, you must type each
name and extension directly from your keyboard after entering this
command.

> ofile

Name of the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
delrsub

13-45

Errors
If either the name or extension doesn’t belong to a valid voice mail system remote
subscriber, an error message displays. If more records exist, subscriber deletion
continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows:
FIELD

Seq.
No.

Field Name

1

name

2

extension/text address

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

C

29

r1v3+

D-r1.0+

I-r2.0+

C

64

r1v3+

D-r1.0+

I-r2.0+

Output Format
The Output Format for each record consists of the command statistics as follows:
REMOTE SUBSCRIBER DELETE ROUTINE ( )
name = _________; extension/text address = _______;
____: DELETED SUB_________

Example
The following command deletes one remote subscriber in the subscriber
database.
delrsub -i "Mary 74199","76199"
"Jones, James","76199" RETURN

RETURN

The following data appears on the screen:
REMOTE SUBSCRIBER DELETE ROUTINE ()
"Jones, James","76199"
name = Jones, James; extension/text address = 76199;
1: DELETED SUB 76199 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
delsub

13-46

delsub
Delete subscriber

Syntax
delsub [-r release] [-v] [-w] [-V] [-i] [ < ifile] [> ofile]

Description
This command deletes subscribers from the current database of the voice mail
system. Use the name and extension as input for each subscriber. Command
statistics are written to standard output.
-r

Release flag; must be followed by release.

release

Deletes data for the specified release of the INTUITY AUDIX,
DEFINITY AUDIX, or R1 AUDIX System software. For the DEFINITY
AUDIX System, the default is D-r3.2. For the INTUITY AUDIX System,
the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Unless -i is specified, pressing v while the command is executing
sends the updated transfer status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file, main.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

-i

Turns off the search for possible subsequent entry of the v and q
(quit) options. Otherwise, if you type ahead, you may lose
characters. If you don’t specify -i, you must specify an input file
(< ifile) from which the names, extensions, etc., will be read.

< ifile

Name of an input file you have created. The filename must be
preceded by the symbol <.
This file contains one or more subscriber records to be deleted.
Each record contains a name and extension. You can edit the output
of the getlist command to generate input to this command. If you
don’t specify an input file, you must type each name and extension
directly from your keyboard after entering this command.

> ofile

Name of the file to which command statistics will be written.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
delsub

13-47

Errors
If either the name or extension doesn’t belong to a valid system subscriber, an
error message displays. If more records exist, subscriber deletion continues.

Input Format
The Input Format consists of one record for each subscriber, formatted as
follows.

FIELD

Seq.
No.

Field Name

1

name

2

extension

VOICE MAIL VERSIONS

Type

Max.
Width

R1
AUDIX
System

DEFINITY
AUDIX
System

INTUITY
AUDIX
System

C

29

r1v2+

D-r1.0+

I-r2.0+

K

10

r1v2+

D-r1.0+

I-r2.0+

When connected to an AUDIX system, only as many characters are required in
the name field as needed to make the name unique (i.e., the name field does not
have to match completely the value on the INTUITY AUDIX System, DEFINITY
AUDIX System or R1 AUDIX System).

Output Format
The Output Format for each record consists of the command statistics as follows:
SUBSCRIBER DELETE ROUTINE ( )
name = _________; extension = _______;
____: DELETED EXT_________

Example
The following command deletes one subscriber from the subscriber database.
delsub -i RETURN
"Doe, John", "3501"

RETURN

The following data appears on the screen:
SUBSCRIBER DELETE ROUTINE ()
"Doe, John","3501"
name = Doe, John; extension = 3501;
1: DELETED EXT 3501 NEWLINE

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
setadj

13-48

setadj
Set machine translation adjunct data

Syntax
setadj -m machine name [-p password ] [-t machine_type]
[-n network_connection_type] [-s data_rate] [-c channel]
[-d dial_string ] [-q purge_queue] [-N new_machine_name]
-r release [-a | -u] [-v] [-w] [-V]

Description
This command sets the field values for the following screen:
■

R1 AUDIX (R1V5 and beyond) system : translation : machine :
adjunct

Note that the header transmission schedule cannot be set with this command.
-m

Machine flag; must be followed by machine name.

machine
name

Sets data for the specified R1 AUDIX machine. Note that a space is
allowed in the machine name provided that the name is enclosed in
quotation marks (such as "new york").

-p

AUDIX password flag; must be followed by password .

password

Sets the password for the specified machine. Valid entries are 5-10
alphanumeric characters.

-t

Machine type flag; must be followed by machine type.

machine
type

Sets the machine type for the specified machine. Valid machine types
are t for text service machine and c for CDR machine. Note that the
machine type may not be changed; you must instead delete and
reenter the machine to change the machine type.

-n

Network connection type flag; must be followed by net connection
type.

net
connect
type

Sets the network connection type for the specified machine. Valid
connection types are dcp, rs232a, and rs232s.

-s

Data rate flag; must be followed by data rate.

data rate

Sets the data rate for the specified machine. Valid data rates are:
dcp: 1200, 2400, 4800, 9600, 19200, 56000, 64000 (bps)
rs232a: 1200, 2400, 4800, 9600, 19200 (bps)
rs232s: 1200, 2400, 4800, 9600, 19200, 56000, 64000 (bps)

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
setadj

13-49

-c

Channel flag; must be followed by channel.

channel

Sets the channel for the specified machine. Valid channels are null
(blank), 5 or 6 for rs232, or null for dcp.

-d

Dial string flag; must be followed by dial string .

dial string

Sets the dial string for the specified machine. Valid entries are 0-65
alphanumeric characters. Null is allowed for a dedicated rs232
connection type.

-q

Purge queue flag; must be followed by purge queue.

purge
queue

Sets the purge queue to on or off for the specified machine. Valid
entries are y for yes or n for no.

-N

New machine name flag; must be followed by new machine name.

new
machine
name

Sets the new machine name for the specified machine. Valid entries
are 1-10 alphanumeric characters.

-r

Release flag; must be followed by release.

release

Sets data for the specified R1 AUDIX System release (R1V5 and
beyond). The default is D-r3.2.

-a | -u

Indicates that the specified machine will be added (a) or deleted (u).

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing sends the updated transfer
status to the screen.

-w

Writes a one-line summary of the exit status of this command into the
file form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

Errors
Using this command with an INTUITY or DEFINITY AUDIX System or an R1 AUDIX
System prior to R1V5, an error message displays.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
setadj

13-50

Example
The following command changes the baud rate for the new york machine on the
system : translation : machine : adjunct screen and writes a summary of the
transfer statistics to the screen.
setadj -m "new york" -s 4800 -r r1v8 -v

RETURN

The following command adds a machine named seattle on the system :
translation : machine : adjunct screen, defines its attributes, and writes a
summary of the transfer statistics to the screen.
setadj -m seattle -p 232124 -t t -n dcp -s 4800 -c -d 12065354808 -q y -a -r
r1v8 -v RETURN
The following command deletes a machine named miami on the system :
translation : machine : adjunct screen and displays summary transfer statistics.
setadj -m miami -u -r r1v8 -v

RETURN

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
setalogp

13-51

setalogp
Set activity log parameters

Syntax
setalogp [-a y/n] [-M y/n] [-N nnnn] [-c y/n] [-r release] [-v] [-w] [-V]

Description
This command sets the field values for the following screens.
■

INTUITY AUDIX Change System-Parameters Activity-Log

■

DEFINITY AUDIX Change System-Parameters Activity-Log

sn.

-a

Activity log flag; must be followed by y or n.

y/n

Activates or deactivates the activity log.

-M

Message waiting indicator (MWI)flag; must be followed by y or n.

y/n

Records or does not record MWIs.

-N

New max. number of activity log entries flag; must be followed by
nnnn.

nnnn

The maximum number of activity log entries. If this number is
smaller than the previous maximum number of entries, the activity
log is cleared.

-c

Clear activity log flag; must be followed by y or n.

y/n

Clears or does not clear the activity log. Defaults to n.

-r

Release flag; must be followed by release.

release

Sends data for the specified release of the INTUITY or DEFINITY
AUDIX System software. For the DEFINITY AUDIX System, the
default is D-r3.2. For the INTUITY AUDIX System, the default is I-r5.0.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while the command is executing displays the updated
transfer status.

-w

Writes a one-line summary of the exit status of this command into
the file, form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
setalogp

13-52

Errors
If you use this command with an R1 AUDIX System, an error message appears.

Example
The following command sets the field values of the Change System-Parameters
Activity-Log screen data and writes a summary of the transfer statistics to the
screen:
setalogp -a y -N 500 -v

RETURN

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
setscdr

13-53

setscdr
Set Call Detail Recording data

Syntax
setscdr [-n nnnnnn] [-a y/n] [-s y/n] [-o y/n] [-N y/n] -r release [-v] [-w] [-V]

Description
This command sets the field values on the system : cdr screen for the options
you specify on the command line. You can use the setscdr command with the R1
AUDIX System (R1V5 and beyond.) No input is required.
NOTE:
To use this command, you must have the separately-purchased Call Detail
Recording (CDR) software.

-a

Active Call Detail Recording indicator flag; must be followed by y or
n.

y/n

Sets the Call Detail Recording active to on (y) or off (n).

-n

Maximum number of CDR records flag; must be followed by nnnnnn.

nnnnnn

Sets the maximum number of CDR records that can be stored
internally in the AUDIX System CDR file. This value must be between
64000 and 128000 inclusive. Deactivate CDR before changing this
field.

-s

Voice session record type flag; must be followed by y or n.

y/n

Sets the voice session record type to on (y) or off (n).

-o

Outgoing call record type flag; must be followed by y or n.

y/n

Sets the outgoing call record type to on (y) or off (n).

-N

Network sessions record type flag; must be followed by y or n.

y/n

Sets the network sessions record type to on (y) or off (n).

-r

Release flag; must be followed by a release.

release

Sets data for the specified R1 AUDIX System release (R1V5 and
beyond). The default is D-r3.2.

-v

Writes transfer statistics to the screen at the end of the transfer.
Pressing v while setscdr is executing sends the updated transfer
status to the screen.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

13 Command Line Database Modification Commands
setscdr

13-54

-w

Writes a one-line summary of the exit status of the this command into
the file form_req.rc.

-V

Writes the ADAP version number for this command and exits without
transferring any screens data.

Errors
If you use this command with an INTUITY or DEFINITY AUDIX System or an R1
AUDIX System prior to R1V5, an error message displays.

Example
The following command sets the system : cdr screen data and writes a summary
of the transfer statistics to the screen.
setscdr -a y -s y -o n -N n -r r1v8 -v

RETURN

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

A Troubleshooting
Establishing a Connection to the System

Troubleshooting

A-1

A

This appendix provides additional information not found in the command
descriptions about error messages and possible abnormal output from the
AUDIX Administration and Data Acquisition Package (ADAP) commands.

Establishing a Connection to the
System
We recommend that you use a Terminal Emulator (such as 513) to debug your
modem connection between the INTUITY AUDIX, DEFINITY AUDIX, or R1 AUDIX
system and your personal computer.

Terminating the Connecting to the
System
If you find that the connection to the voice mail system (INTUITY AUDIX, DEFINITY
AUDIX, or R1 AUDIX system) is not being dropped after the logout command has
been issued, check the option switches on your modem. The logout command
makes sure that the DTR (data terminal ready) lead on the modem cable is held
low for 500 msec. This is long enough for most modems to drop the connection.

Retrieving Data During Peak Usage
Avoid collecting traffic and subscriber data when many users are logged in to the
voice mail system. It is best to collect these files after prime time hours. For a
given number of subscribers, collection may take more than twice as long when
traffic is heavy as it does when traffic is light.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

A Troubleshooting
Interactions Between Terminals On AUDIX Systems

A-2

Interactions Between Terminals On
AUDIX Systems
You should be aware of the fact that activity on the maintenance terminal can
affect the behavior of data retrievals from the administration port. The operations
that are most sensitive to these interactions are retrieval of error and alarm log
data. For example, a person on the maintenance terminal can change the error
log search specification that was just sent by ADAP using the geterror
command. This will result in erroneous data being returned.

Timeouts
The voice mail system will drop terminal sessions after one hour of inactivity. If
this occurs before you have finished, you must log in again.

Data Acquisition Problems
There are two types of error messages that you might see — fatal and nonfatal.
As you would expect, fatal messages are displayed just before the command
you are executing quits. After six nonfatal errors when connected to an AUDIX
system, ADAP commands will quit. Examples of fatal and nonfatal errors follow:
■

Fatal: If you don’t specify a day or month after the -f flag, you will receive a
fatal error.

■

Nonfatal: If you specify an invalid extension while using the gettraf
command, you will receive a nonfatal error.

One class of errors is associated with improper command syntax. These error
messages are self explanatory.
A table describing driver errors is shown in Appendix B.
Most protocol errors are recoverable; they indicate that the protocol is recovering
from a noise hit on the line. If you see an error message that indicates a protocol
error: log out, log in again, and repeat the command. If the same error occurs,
get a printout of the error (if possible) and call your remote maintenance service
center. For example, you may call the national trouble reporting number
(1-800-242-2121).

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

A Troubleshooting
Alogin (Automated Login) Problems

A-3

Alogin (Automated Login) Problems
To use alogin, make sure that your configuration complies with the guidelines
described in Chapter 2, "Installation".
If the alogin command does not make a successful connection, include the -v
flag the next time you run the command. This option (the verbose flag) will
display on the screen all input that alogin is sending to the voice mail system,
and all of the system’s responses. The most common error is due to an invalid
login name/password/system password being specified on the alogin command
line.

Common Problems and Solutions
Listed on the following pages are typical problems that you may encounter,
along with their solutions.

Connection Problems with Login Commands:
Problem

The software expects to receive a data set ready signal during the login
process. If it does not, you will receive one of the following error
messages:
(ALOGIN)
eopen of port 0 failed, rc = 0x85.
Processing stopped.

(LOGIN)
FATAL ERROR:System error; login.c, 84, 133.
Processing stopped.
Solution

This problem is most often seen with Hayes modems. Use the -i option
to bypass the search for the DSR signal.

Problem

When you attempt to log into the voice mail system using an invalid
argument or option with the login command (for example, an invalid
delete or password), the command will fail.

Solution

When you log into the voice mail system, use the -v option with the
login command. Detailed transfer statistics of the login command
status and the voice mail system connect responses will then be written
to the screen. These statistics will help you determine the solution to
this problem.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

A Troubleshooting
Common Problems and Solutions

A-4

Problems Encountered During Data Retrieval or
Database Modification:
Problem

If you attempt either to retrieve the voice mail system data or to change
a subscriber record, you may encounter the following error:
FATAL ERROR: HARDWARE ERROR; Cannot
write auxiliary port 1.
Processing stopped.
If this happens, you have not logged into the voice mail system.

Solution

Log into the voice mail system, using either alogin or login.

Problem

If you attempt to retrieve the DEFINITY AUDIX data, you may encounter
the following error:
SENT TOO MANY NAKS
If you attempt to retrieve the AUDIX data, you may encounter the
following error:
DATA ERROR: PROTOCOL ERROR:
12 consecutive sinit retries.
Processing stopped.
You have either entered the wrong terminal type, entered wrong release
value for the -r option or your connection to the voice mail system has
been dropped because of a timeout.

Solution

Log into the voice mail system, using either alogin or login.

Problem

While running the Sample Application programs, you may receive the
following error message:
Too many files are open.
Do errorchk with error()
If you receive this error, the parameter FILES is not set correctly in your
config.sys file.

Solution

At the C> prompt, access your config.sys file and set FILES to 20 and
BUFFERS to 15.

Problem

Some symptoms of insufficient memory or disk storage are as follows:

Solution

■

Graphic output flashing on and off very quickly

■

Error message from dBASE III PLUS indicating insufficient available
memory to load dBASE III PLUS

Use the MS-DOS chkdsk command to see the number of free bytes
remaining on your PC. To run MS-DOS, dBASE III PLUS, and the
graphics software, approximately 357,000 total bytes should be free for
conventional program execution memory.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

A Troubleshooting
Common Problems and Solutions

A-5

Problem

If your hardware setup includes an IBM monochrome display, you won’t
be able to use graphic output (this includes viewing on-line help
information for the PC2AUDIX interface).

Solution

With the graphics software, the only solution is to use another monitor.
You can eliminate the problem with viewing the on-line help information
by using a modified help file available by calling your remote
maintenance service center. For example, you may call the Technical
Service Organization at 1-800-242-2121.

Problem

If your MS-DOS version is older than version 3.1, the add, change, and
delete subscriber capabilities will not work, and you will see the
following error message:
Unknown program name

Solution

Install MS-DOS 3.1 or a newer version on your PC.

Problem

When you retrieve data using a direct connection to the voice mail
system, you may notice inaccuracies. For reliable data retrieval, the
length of the RS-232 cable connected to the back of your PC should not
exceed 50 feet.

Solution

Examine the RS-232 cable connected to the back of your PC. If its
length exceeds 50 feet, replace the cable with a shorter one.

Problem

If you are using version R1V3 or R1V2 of the AUDIX software and are
running the PC2AUDIX interface to retrieve hourly, daily, or monthly
system data, you may encounter the following error message:
FATAL ERROR: SYSTEM ERROR;
ret_rem.c, 82,2 (tr_remda -d date)
If this happens, you have specified a software version other than R1V2
or R1V3 on the PC2AUDIX Setup Parameters menu before selecting
Data Retrieval on the PC2AUDIX Root Menu. The R1 AUDIX list :
machine form changed with version R1V4.

Solution

Return to the PC2AUDIX Setup Parameters menu, and specify the
correct software version.

Problem

If the ADAPROOT environment variable is set incorrectly, you may
encounter the following error:
zopeno can’t open: No such file or directory
Can’t open file

Solution

If this happens, enter the SET command to display a list of environment
variables and look for the "ADAPROOT=" line. If it is there, make sure
that it references the same drive and directory that was used during
installation. If not, or if the "ADAPROOT=" line is not in the list, enter the
following command:
SET ADAPROOT=:\

where  is the drive letter and  is the directory path
name that were used during installation. For further information, see
Section 2.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

A Troubleshooting
Common Problems and Solutions

A-6

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

B RS-232 Driver Errors
Converting Error Return Codes into RS-232 Driver Error Codes

RS-232 Driver Errors

B-1

B

If a driver error occurs during the form retrieval process, the data acquisition
software writes a text message, containing an error return code in hexadecimal
format, to your screen. This appendix contains:
■

A driver error table

■

Directions for converting the hexadecimal error return codes written to
your screen into the driver error codes shown in the table

Converting Error Return Codes into
RS-232 Driver Error Codes
To convert the hexadecimal error return code into a driver error code, you must
first convert the hexadecimal number into a binary number and then look up the
position number of the bits that are on.
To convert the hexadecimal error return code into a driver error code:
1. Convert the hexadecimal error number on your screen to a binary number.
Binary equivalents for hexadecimal numbers, in groups of four bits for
each hexadecimal digit, are shown on the next page.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

B RS-232 Driver Errors
Converting Error Return Codes into RS-232 Driver Error Codes

B-2

Hexadecimal Equivalents
Hexadecimal

Binary

Hexadecimal

Binary

0

0000

8

1000

1

0001

9

1001

2

0010

A

1010

3

0011

B

1011

4

0100

C

1100

5

0101

D

1101

6

0110

E

1110

7

0111

F

1111

For example, in the following table, the error number 85 (shown on the first
line below) is the binary number 10000101 (shown on the second line).
Example Conversion
Hexadecimal error

8

5

Bit value

1000

0101

Bit position

7654

3210

In the binary number 10000101, each binary digit is called a bit. A one
means the bit is on, while a zero means the bit is off.
The bit positions, reading from left to right, are 76543210 (shown on the
third line).
2. Look at the last three bits on the right (101 in the above sample). These
bits are the completion code that tells whether the command succeeded,
or whether it failed and why.
3. Look up the completion code number in the RS-232 driver error table
below. You will see that the error represented by the value 101 is No DSR
(line break).

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

B RS-232 Driver Errors
Converting Error Return Codes into RS-232 Driver Error Codes

B-3

Driver Errors
Bit Positions
2 to 0

Errors

Bit Type

Completion Code:
000 = Successful completion
001 = "Busy" or "no character ready"
010 = Parameter error
011 = Not opened
100 = Not closed
101 = No DSR (line break)
110 = No CTS (modem error)
111 = Illegal command

3

Overrun error

Receive only

4

Parity error

Receive only

5

Framing error

Receive only

6

Break detected

Receive only

7

Timeout indicator

4. Notice whether a 1 is in any of the bit positions 3, 4, 5, 6, or 7.
5. Look up the corresponding bit position number in the driver error table to
obtain further error information.
For example, in the example conversion table above, bit number 7 is on. If
you look in the driver error table, you will see that this number corresponds
with Timeout indicator.
Of the completion codes, the only one that should appear is 101 (No DSR). The
DSR line in the interface cable between the DEFINITY AUDIX System or R1
AUDIX system and the PC carries a signal that controls the flow of data. When
error 101 appears on your screen, this control signal either is not present or is in
the wrong state. None of the other completion codes should be seen.
When the driver is opened, it is told to ignore CTS (Clear to Send) errors.
Driver errors may be accompanied by the timeout indicator.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

B RS-232 Driver Errors
Converting Error Return Codes into RS-232 Driver Error Codes

B-4

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-1

Abbreviations
AB
A
AC
alternating current
ACD
automatic call distribution
ADAP
administration and data acquisition package
ADU
asynchronous data unit
ALT
assembly load and test
AMIS
Audio Messaging Interchange Specification
API
application programming interface
AT&T
American Telegraph and Telephone
AUDIX
Audio Information Exchange
AWG
American wire gauge

B
BIOS
basic input/output system
bps
bits per second
BRI
basic rate interface
BSC
binary synchronous communications
BTU
British thermal unit

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-2

C
CCA
call classification analysis
CDH
call data handler process
CELP
code excited linear prediction
CIC
customer information center
CICS
customer information control system
CO
central office
COIN
central office implemented network
COM1
serial communications port 1
COM2
serial communications port 2
COR
class of restriction
COS
class of service
CPU
central processing unit
CSI
called subscriber information
CTS
clear to send

D
DAC
dial access code
DC
direct current
DCE
data communications equipment

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-3
DCIU
data communications interface unit
DCP
digital communications protocol
DCS
distributed communications system
DID
direct inward dialing
DIP
data interface process
DMA
direct memory access
DNIS
dialed number identification service
DSP
digital signal processor
DSU
data service unit
DTE
data terminal equipment
DTMF
dual tone multifrequency
DTR
data terminal ready

E
EIA
Electronic Industries Association
ESD
electrostatic discharge
ESS
electronic switching system

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-4

F
FIFO
first-in first-out
FOOS
facility out of service

G
GBCS
Global Business Communications Systems
GOS
grade of service

H
Hz
hertz

I
IDI
isolating data interface
IMAPI
Lucent INTUITY messaging application programming interface
INADS
initialization and administration system
I/O
input/output
IRQ
interrupt request
ISDN
integrated services digital network
IVC6
integrated voice CELP card (6 channels)

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-5

K
Kbps
kilobits per second
Kbyte
kilobyte (1024 bytes)
kHz
kilohertz

L
LAN
local area network
LCD
liquid crystal display
LED
light-emitting diode
LWC
leave word calling

M
MANOOS
manually out of service
Mbyte
megabyte (one million bytes)
MHz
megahertz
modem
modulator/demodulator
MPDM
modular processor data module
ms
millisecond
MT
maintenance (Lucent INTUITY software component)

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-6
MTBF
mean time between failures
MWI
message-waiting indicator

N
NW
Lucent INTUITY AUDIX Digital Networking

O
OA&M
operations, administration, and maintenance
OS
operating system

P
PBX
private branch exchange
PC
power converter or personal computer
PDM
processor data module
PEC
price element code
POST
power-on self test

R
RAM
random-access memory
REN
ringer equivalence number

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-7
ROM
read-only memory
RTS
request to send
RTU
right to use

S
SCSI
small computer systems interface
SID
switch integration device
SIMM
single in-line memory module
SMSI
simplified message service interface
SW
switch integration (Lucent INTUITY software component)

T
TDD
telecommunications device for the deaf
TDM
time division multiplex
T/R
tip/ring
TRIP
tip/ring input process
TSC
Lucent’s Technical Services Center

AUDIX Administration and Data Acquisition Package 585-302-502

AB

Issue 14
May 1999

Abbreviations

AB-8

U
UCD
uniform call distribution
UPS
uninterruptible power supply

V
VM
INTUITY AUDIX Voice Messaging
VP
voice platform (Lucent INTUITY software component)
VR
Lucent INTUITY Intro Voice Response
VROP
voice response output process

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-1

Glossary
GL
1A ESS Switch
A Lucent central office switch that can be integrated with the Lucent INTUITY system.
5ESS Switch
A Lucent central office switch that can be integrated with the Lucent INTUITY system.

A
accessed message
A voice mail message that was received and scanned (either the entire message or just the
header).
ACD
See automatic call distribution.
activity menu
The list of options voiced to INTUITY AUDIX subscribers when they first access the system.
Selecting an activity is the starting point for all user operations.
ADAP
See administration and data acquisition package.
address
INTUITY AUDIX subscriber identification, containing the subscriber’s extension and machine, that
indicates where the system needs to deliver a voice mail message. An address may include
several subscribers or mailing lists. Name or number addressing can be selected with the *A
command.
adjunct
A separate system closely integrated with a switch, such as a Lucent INTUITY system or a call
management system (CMS).
administration
The process of setting up a system (such as a switch or a voice messaging system) to function as
desired. Options and defaults are normally set up (translated) by the system administrator or
service personnel.
administration and data acquisition package (ADAP)
A software package that allows the system administrator to transfer system subscriber,
maintenance, or traffic data from an INTUITY AUDIX system to a personal computer (PC).
ADU
See asynchronous data unit.
alarm log
A list of alarms that represent all of the active or resolved problems on a Lucent INTUITY system.
The alarm log is stored in a software file on disk and can be accessed either locally or remotely on
a terminal connected to the system.
alarms
Hardware, software, or environmental problems that may affect system operation. Alarms are
classified as major, minor, or warning.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-2
alphanumeric
Alphabetic, numeric, or punctuation symbols.
AMIS
See Audio Messaging Interchange Specification.
AMIS Prefix
A number added to the destination number to indicate that the destination number is an AMIS
analog networking number.
ampere (amp)
The unit of measurement of electric current. One volt of potential across one ohm causes a current
flow of one amp.
analog networking
A method of transferring a voice mail message from one voice messaging system to another
whereby the message is played back (voiced) during the transmission from one system to another.
analog signal
A communications path that, in teleprocessing usage, usually refers to a voice-grade telephone
line.
announcement fragment
A numbered piece of spoken information that makes up a system message or prompt.
antistatic
A material that is treated to prevent the build-up of static electricity.
asynchronous communication
A method of data transmission in which bits or characters are sent at irregular intervals and bits or
characters are spaced by start and stop bits and not by time. See also synchronous
communication.
asynchronous data unit (ADU)
An electronic communications device that can extend data transmission over asynchronous lines
more than 50 feet in length. Recommended ADUs include Z3A1 or Z3A4.
asynchronous transmission
A form of serial communications where each transmitted character is bracketed with a start bit and
one or two stop bits. The Lucent INTUITY system provides asynchronous RS-232 capabilities for
INTUITY AUDIX Digital Networking, if required.
Audio Messaging Interchange Specification (AMIS)
An analog networking feature that allows subscribers to exchange voice mail messages with any
voice messaging system that also has AMIS Analog Networking capabilities. Messages can be
exchanged with subscribers on Lucent INTUITY systems as well as with users on remote voice
messaging systems made by vendors other than Lucent.
Audio Information Exchange (AUDIX)
A complete voice messaging system accessed and operated by touch-tone telephones and
integrated with a switch.
audit
A software program that resolves filesystem incompatibilities and updates restored filesystems to a
workable level of service. Audits are done automatically on a periodic basis, or can be performed
on demand.
AUDIX
See Audio Information Exchange.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-3
autodelete
An INTUITY AUDIX feature that allows subscribers to indicate that faxes are automatically deleted
from their mailbox after being printed.
automated attendant
A feature that allows a user of a Lucent INTUITY system to set up a main extension number with a
menu of options that routes callers to an appropriate department at the touch of a button.
automatic call distribution (ACD)
The System 85, Generic 2, or Generic 3 call-distribution group of analog ports that connects
Lucent INTUITY subscribers and users to the system. See also call-distribution group .
automatic message scan
An INTUITY AUDIX feature that allows subscribers to scan all message headers and messages at
the touch of two buttons. With Lucent INTUITY FAX Messaging, this feature allows all new faxes to
be bundled and transmitted over a single fax call delivery call. Also called autoscan.
autoprint
An INTUITY AUDIX feature that allows subscribers to indicate that faxes are automatically sent to a
specified print destination.
autoscan
See automatic message scan.

B
background testing
Testing that runs continuously when the system is not busy doing other tasks.
backup
A duplicate copy of files and directories saved on a removable media such as floppy diskette or
tape. The backup filesystem may be copied back (restored) if the active version is damaged
(corrupted) or lost.
basic input/output system (BIOS)
A system that contains the buffers for sending information from a program to the actual hardware
device the information should go to.
baud
A unit of measurement that describes the speed of transferred information.
baud rate
Transmission signaling speed.
basic call transfer
A switch hook-flash method used to send the INTUITY AUDIX transfer command over analog voice
ports.
basic rate access
See basic rate interface.
basic rate interface (BRI)
International standard protocol for connecting a station terminal to an integrated systems digital
network (ISDN) switch. ISDN BRI supports two 64 Kbps information bearer channels (B1 and B2),
and one 16 Kbps call status and control (D) channel (a 2B + D format). Also called b asic rate
access.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-4
binary digit (bit)
Two-number notation that uses the digits 0 and 1. Low-order bits are on the right (for example,
0001=1, 0010=2, and so forth). Four bits make a nybble; eight bits make a byte.
binary synchronous communications (BSC)
A character-oriented synchronous link protocol.
BIOS
See basic input/output system.
bit
See binary digit.
body
The part of subscriber voice mail that contains the actual spoken message. For a leave word
calling (LWC) message, it is a standard system announcement.
boot
The operation to start a computer system by loading programs from disk to main memory (part of
system initialization). Booting is typically accomplished by physically turning on or restarting the
system. Also called reboot.
boot filesystem
The filesystem from which the system loads its initial programs.
bps (bits per second)
The number of binary units of information (1s or 0s) that can be transmitted per second. Mbps
refers to a million bits per second; Kbps refers to a thousand bits per second.
BRI
See basic rate interface.
broadcast messaging
An INTUITY AUDIX feature that enables the system administrator and other designated users to
send a message to all subscribers automatically.
BSC
See binary synchronous communications.
buffer
Memory used to compensate for time differences in transmission by temporarily storing data.
bulletin board
An INTUITY AUDIX feature that allows a message to be played to callers who dial the extension.
Callers cannot leave a message since it is a listen-only service. Also called information service.
bundling
Combining several calls and handling them as a single call. See also automatic message scan.
bus
An electrical connection/cable allowing two or more wires, lines, or peripherals to be connected
together.
busy-out/release
To remove a Lucent INTUITY device from service (make it appear busy or in use), and later restore
it to service (release it). The Lucent INTUITY switch data link, voice ports, or networking ports may
be busied out if they appear faulty or if maintenance tests are run.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-5
byte
A unit of storage in the computer. On many systems, a byte is eight bits (binary digits), the
equivalent of one character of text.

C
call-answer
An INTUITY AUDIX feature that allows the system to answer a call and record a message when the
subscriber is unavailable. Callers may be redirected to the system through the call coverage or
call forwarding switch features. Subscribers may record a personal greeting for these callers.
call-answer language choice
The capability of subscriber mailboxes to accept messages in either of two different languages.
This capability exists when the multilingual feature is turned on.
callback number
In AMIS analog networking, the telephone number transmitted to the recipient machine to be used
in returning voice mail messages that cannot be delivered.
call coverage
A switch feature that defines a preselected path for calls to follow if the first (or second) coverage
points are not answered. The Lucent INTUITY system may be placed at the end of a coverage path
to handle redirected calls through call coverage, send all calls, go to cover, etc.
call delivery
See message delivery.
call-distribution group
The set of analog port cards on the switch that connects subscribers and users to the Lucent
INTUITY system by distributing new calls to idle ports. This group (or split) is called automatic call
distribution (ACD) on System 85, Generic 2, and Generic 3 and uniform call distribution (UCD) on
System 75, Generic 1, and Generic 3. See also automatic call distribution and uniform call
distribution.
called tone (CED tone)
The distinctive tone generated by a fax endpoint when it answers a call (constant 2100 Hz tone).
called subscriber information (CSI)
The identifier for the answering fax endpoint. This identifier is sent in the T.30 protocol and is
generally the telephone number of the fax endpoint.
calling tone (CNG tone)
The distinctive tone generated by a fax endpoint when placing a call (constant 1100 Hz tone on for
one-half second, off for three seconds).
call vectoring
A System 85 R2V4, Generic 2, and Generic 3 feature that uses a vector (switch program), allowing
a switch administrator to customize the behavior of calls sent to an automatic call distribution
(ACD) group.
card cage
An area within the Lucent INTUITY hardware platform that contains and secures all of the standard
and optional circuit cards used in the system.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-6
cartridge tape drive
A high-capacity data storage/retrieval device that can be used to transfer large amounts of
information onto high-density magnetic cartridge tape based on a predetermined format. This
tape is to be removed from the system and stored as a backup.
CED tone
See called tone.
central office (CO)
An office or location in which large telecommunication machines such as telephone switches and
network access facilities are maintained. In a CO, private customer lines are terminated and
connected to the public network through common carriers.
central processing unit (CPU)
The component of the computer that manipulates data and processes instructions coming from
software.
channel capacity
A measure of the maximum bit rate through a channel.
class of service (COS)
The standard set of INTUITY AUDIX features given to subscribers when they are first administered
(set up with a voice mailbox).
clear to send (CTS)
Located on Pin 5 of the 25-conductor RS-232 interface, CTS is used in the transfer of data
between the computer and a serial device.
client
A computer that sends, receives and uses data, but that also shares a larger resource whose
function is to do most data storage and processing. For Lucent INTUITY Message Manager, the
subscriber’s PC running Message Manager is the client. See also server.
CNG tone
See calling tone.
CO
See central office.
collocated
A Lucent INTUITY system installed in the same physical location as the host switch. See also local
installation.
collocated adjunct
Two or more adjuncts that are serving the same switch (i.e., each has voice port connections to the
switch) or that are serving different switches but can be networked through a direct RS-232
connection due to their proximity.
comcode
Lucent’s numbering system for telecommunications equipment. Each comcode is a nine digit
number that represents a specific piece of hardware, software, or documentation.
command
An instruction or request given by the user to the software to perform a particular function. An
entire command consists of the command name and options. Also, one- or two-key touch tones
that control a voice mailbox activity or function.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-7
compound message
A message that combines both a voice message and a fax message into one unit, which is then
handled by INTUITY AUDIX as a single message.
configuration
The particular combination of hardware and software components selected for a system, including
external connections, internal options, and peripheral equipment.
controller circuit card
A circuit card used on a computer system that controls its basic functionality and makes the
system operational. These cards are used to control magnetic peripherals, video monitors, and
basic system communications.
COS
See class of service.
coverage path
The sequence of alternate destinations to which a call is automatically sent when the call is not
answered by a subscriber. This sequence is set up on the switch, normally with INTUITY AUDIX as
the last or only destination.
CPU
See central processing unit.
cross connect
Distribution system equipment used to terminate and administer communication circuits.
cross connection
The connection of one wire to another, usually by anchoring each wire to a connecting block and
then placing a third wire between them so that an electrical connection is made.
CSI
See called subscriber information.
CTS
See clear to send .

D
database
A structured set of files, records, or tables. Also, a collection of filesystems and files in disk
memory that store the voice and nonvoice (program data) necessary for Lucent INTUITY system
operation.
data communications equipment (DCE)
Standard type of data interface normally used to connect to data terminal equipment (DTE)
devices. DCE devices include the data service unit (DSU), the isolating data interface (IDI), and
the modular processor data module (MPDM).
data communications interface unit (DCIU)
A switch device that allows nonvoice (data) communication between a Lucent INTUITY system and
a Lucent switch. The DCIU is a high-speed synchronous data link that communicates with the
common control switch processor over a direct memory access (DMA) channel that reads data
directly from FP memory.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-8
data link
A term used to describe the communications link used for data transmission from a source to a
destination. For example, a phone line for data transmission.
data service unit (DSU)
A device used to access digital data channels. DATAPHONE II 2500 DSUs are synchronous data
communications equipment (DCE) devices used for extended-local Lucent INTUITY system
connections. The 2600 or 2700 series may also be used; these are more expensive DSU options
and support diagnostic testing and the DATAPHONE II Service network system.
data set
Lucent term for a modem. A data set usually includes the telephone. See also modem.
data terminal equipment (DTE)
Standard type of data interface normally used for the endpoints in a connection. Normally the
Lucent INTUITY system, most terminals, and the switch data link are DTE devices.
data terminal ready (DTR)
A control signal sent from the data terminal equipment (DTE) to the data communications
equipment (DCE) that indicates the DTE is on and ready to communicate.
DBP
See data base processor.
DCE
See data communications equipment.
DCIU
See data communications interface unit.
DCP
See digital communications protocol.
DCS
See distributed communications system.
debug
See troubleshoot.
dedicated line
A communications path that does not go through a switch. A dedicated (hard-wired) path may be
formed with directly connected cables. MPDMs, DSUs, or other devices may also be used to
extend the distance that signals can travel directly through the building wiring.
default
A value that is automatically supplied by the system if no other value is specified.
default print number
The subscriber-administered extension to which autoprinted faxes are redirected upon their
receipt into the subscriber’s mailbox. This default print destination is also provided as a print
option when the subscriber is manually retrieving and printing faxes from the mailbox.
delivered message
A voice mail message that has been successfully transmitted to a recipient's incoming mailbox.
demand testing
Testing performed on request (usually by service personnel).
diagnostic testing
A program run for testing and determining faults in the system.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-9
dial-ahead/dial-through
The act of interrupting or preceding INTUITY AUDIX system announcements by typing (buffering)
touch-tone commands in the order the system would normally prompt for them.
digital
Discrete data or signals such as 0 and 1.
digital communications protocol (DCP)
A 64 Kbps digital data transmission code with a 160 Kbps bipolar bit stream divided into two
information (I) channels and one signaling (S) channel.
digital networking
A method of transferring voice mail messages between voice messaging systems in a digital
format. See also INTUITY AUDIX Digital Networking .
DIP switch
See dual in-line package switch.
direct memory access (DMA)
A quick method of moving data from a storage device directly to RAM, which speeds processing.
directory
An INTUITY AUDIX feature allowing you to hear a subscriber’s name and extension after typing **N
at the activity menu. Also, a group of related files accessed by a common name in software.
display terminal
A data terminal with a screen and keyboard used for displaying Lucent INTUITY screens and
performing maintenance or administration activities.
distributed communications system (DCS)
A network of two or more switches that uses logical and physical data links to provide full or partial
feature transparency. Voice links are made using tie trunks.
distribution list
See mailing list.
DMA
See direct memory access.
DSR
See data set ready.
DSU
See data service unit.
DTE
See data terminal equipment.
DTR
See data terminal ready.
dual in-line package (DIP) switch
A very small switch, usually attached to a printed circuit card, in which there are only two settings:
on or off (or 0 or 1). DIP switches are used to configure the card in a semipermanent way.
dual language greetings
The capability of INTUITY AUDIX subscribers to create personal greetings in two different
languages — one in a primary language and one in a secondary language. This capability exists
when the multilingual feature is turned on and the prompts for subscriber mailboxes can be in
either of the two languages.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-10

E
electrostatic discharge (ESD)
Discharge of a static charge on a surface or body through a conductive path to ground. An ESD
can be damaging to integrated circuits.
enabled/disabled
The state of a hardware device that indicates whether the Lucent INTUITY system can use it.
Devices must be equipped before they can be enabled (made active). See also equipped/
unequipped .
endpoint
See fax endpoint.
enhanced call transfer
An INTUITY AUDIX feature that allows compatible switches to transmit messages digitally over the
BX.25 (data) link. This feature is used for quick call transfers and requires a fully integrated digital
switch. Callers can only transfer to other extensions in the switch dial plan.
enhanced serial data interface
A software- and hardware-controlled method used to store data on magnetic peripherals.
equipped/unequipped
The state of a networking channel that indicates whether Lucent INTUITY software has recognized
it. Devices must be equipped before they can be enabled (made active). See also enabled/
disabled .
error message
A message on the screen indicating that something is wrong and possibly suggesting how to
correct it.
errors
Problems detected by the system during operation and recorded in the maintenance log. Errors
can produce an alarm if they exceed a threshold.
escape from reply
The ability to quickly return to getting messages for a subscriber who gets stuck trying to respond
to a message. To escape, the subscriber simply presses #.
escape to attendant
An INTUITY AUDIX feature that allows a subscriber with the call answer feature to have a personal
attendant or operator administered to potentially pick up an unanswered call. A system-wide
extension could also be used to send callers to a live agent.
ESD
See electrostatic discharge.
events
Informational messages about the system’s activities. For example, an event is logged when the
system is rebooted. Events may or may not be related to errors and alarms.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-11

F
fax endpoint
Any device capable of receiving fax calls. Fax endpoints include fax machines, individual PC fax
modems, fax ports on LAN fax servers, and ports on fax-enabled messaging systems.
field
An area on a screen, menu, or report where information can be typed or displayed.
file
A collection of data treated as a basic unit of storage.
filename
Alphanumeric characters used to identify a particular file.
file redundancy
See mirroring .
filesystem
A collection of related files (programs or data) stored on disk that are required to initialize a Lucent
INTUITY system and provide full service.
F key
See function key.
format
To set up a disk, floppy diskette, or tape with a predetermined arrangement of characters so that
the system can interpret meaningful information.
function
Individual steps or procedures within a voice mailbox activity.
function key (F key)
A key on a computer keyboard that performs a defined function when pressed. The user interface
for the Lucent INTUITY system defines keys F1 through F8.

G
Generic 1, 2, or 3
Lucent switch system software releases. Generic 1, Generic 3i, and Generic 3s correspond to the
new generation of System 75-based software. Generic 2 and Generic 3r correspond to the new
release of System 85-based software.
generic tape
A copy of the standard software and standalone tape utilities that is shipped with a new Lucent
INTUITY system.
GOS
See grade of service.
grade of service (GOS)
A parameter that describes the delays in accessing a port on the INTUITY system. For example, if
the GOS is P05, 95% of the callers would hear the system answer and 5% would hear ringing until
a port became available to answer the call.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-12
guaranteed fax
A feature of INTUITY FAX Messaging that temporarily stores faxes sent to a fax machine. In cases
where the fax machine is busy or does not answer a call, the call is sent to an INTUITY AUDIX
mailbox.
guest password
A feature that allows users who are not INTUITY AUDIX subscribers to leave messages on the
system by dialing a subscriber’s extension and entering a system-wide guest password.

H
hard disk drive
A high-capacity data storage/retrieval device that is located inside a computer platform. A hard
disk drive stores data on non-removable high-density magnetic media based on a predetermined
format for retrieval by the system at a later date.
hardware
The physical components of a computer system. The central processing unit, disks, tape and
floppy drives are all hardware.
header
Information that the system creates to identify a message. A message header includes the
originator or recipient, type of message, creation time, and delivery time.
help
A command run by pressing HELP or CTRL ? on a Lucent INTUITY display terminal to show
the options available at your current screen position. In the INTUITY AUDIX system, press
* H
on the telephone keypad to get a list of options. See also on-line help .
hertz (Hz)
A measurement of frequency in cycles per second. A hertz is one cycle per second.
host switch
The switch directly connected to the Lucent INTUITY system over the data link. Also, the physical
link connecting a Lucent INTUITY system to a distributed communications system (DCS) network.
hunt group
A group of analog ports on a switch usually administered to search for available ports in a circular
pattern.
Hz
See hertz.

I
IDI
See isolating data interface.
IMAPI
See Lucent INTUITY messaging application programming interface.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-13
INADS
See initialization and administration system.
information service
See bulletin board .
initialization
The process of bringing a system to a predetermined operational state. The start-up procedure
tests hardware; loads the boot filesystem programs; locates, mounts, and opens other required
filesystems; and starts normal service.
initialization and administration system (INADS)
A computer-aided maintenance system used by remote technicians to track alarms.
initialize
To start up the system for the first time.
input
A signal fed into a circuit or channel.
integrated services digital network (ISDN)
A network that provides end-to-end digital connectivity to support a wide range of voice and data
services.
integrated voice processing CELP (IVC6) card
A computer circuit card that supports both fax processing and voice processing capabilities. It
provides two analog ports to support six analog channels. All telephone calls to and from the
Lucent INTUITY system are processed through the IVC6 card.
interface
The device or software that forms the boundary between two devices or parts of a system,
allowing them to work together. See also subscriber interface.
interrupt request (IRQ)
A device that signals the data bus and the CPU that it needs attention.
INTUITY AUDIX Digital Networking
A Lucent INTUITY feature that allows customers to link together up to 500 remote Lucent INTUITY
machines for a total of up to 500,000 remote subscribers. See also digital networking .
Lucent INTUITY Message Manager
A Windows-based software product that allows INTUITY AUDIX subscribers to receive, store, and
send their voice/FAX messages from a PC.
Lucent INTUITY messaging application programming interface (IMAPI)
A software function-call interface that allows INTUITY AUDIX to interact with Lucent INTUITY
Message Manager.
I/O address
input/output address.
IRQ
See interrupt request.
ISDN
See integrated services digital network.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-14
isolating data interface (IDI)
A synchronous, full duplex data device used for cable connections between a Lucent INTUITY
GPSC-AT/E card and the switch data communications interface unit (DCIU).
IVC6 card
See integrated voice processing CELP (IVC6) card.

J
jumper
Pairs or sets of small prongs on circuit cards and mother boards that allow the user to instruct the
computer to select one of its available operation options. When two pins are covered, an electrical
circuit is completed.

K
Kbps
kilobits per second. One thousand bits per second.

L
label
The name assigned to a disk device (either a removable tape cartridge or permanent drive)
through software. Cartridge labels may have a generic name (such as 3:3) to show the software
release or a descriptive name if for backup copies (such as back01). Disk drive labels usually
indicate the disk position (such as disk00 or disk02).
LAN
See local area network.
LCD
See liquid crystal display.
leave word calling (LWC)
A switch feature that allows the calling party to leave a standard (nonvoice) message for the called
party using a feature button or dial access code.
LED
See light emitting diode.
light emitting diode (LED)
A light indicator on the hardware platform that shows the status of operations.
liquid crystal display (LCD)
The 10-character alphanumeric display that shows status of the system, including alarms.
load
To read software from external storage (such as disk) and place a copy in system memory.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-15
local area network (LAN)
A network of PCs that communicate with each other and that normally share the resources of one
or more servers. Operation of INTUITY Message Manager requires that the INTUITY AUDIX system
and the subscribers’ PCs are on a LAN.
local AUDIX machine
The AUDIX system where a subscriber's voice mailbox is located. All subscribers on this home
machine are called local subscribers.
local installation
A switch, adjunct, or peripheral equipment installed physically near the host switch or system. See
also collocated .
local network
An INTUITY AUDIX Digital Network in which all Lucent INTUITY systems are connected to the same
switch.
login
A unique code used to gain approved access to the Lucent INTUITY system. See also password .
login announcement
A feature enabling the system administrator and other designated users to create a voice mail
message that is automatically played to all INTUITY AUDIX subscribers every time they login to the
system.

M
magnetic peripherals
Data storage devices that use magnetic media to store information. Such devices include hard
disk drives, floppy disk drives, and cartridge tape drives.
mailbox
A portion of disk memory given to each INTUITY AUDIX subscriber for creating and storing
outgoing and incoming messages.
mailing list
A group of INTUITY AUDIX subscriber addresses assigned a list ID# and public or private status.
A mailing list may be used to simplify sending messages to several subscribers.
maintenance
The process of identifying system errors and correcting them, or taking steps to prevent problems
from occurring.
major alarm
An alarm detected by INTUITY software that affects at least one fourth of the INTUITY ports in
service. Often a major alarm indicates that no service is available.
multi-application platform (MAP)
The computer hardware platform used by the Lucent INTUITY system. Currently, a MAP/5, MAP/40,
and MAP/100 are available.
megabyte
A unit of memory equal to 1,048,576 bytes (1024 x 1024). It is often rounded to one million.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-16
memory
A device which can store logic states such that data can be accessed and retrieved. Memory
may be temporary (such as system RAM) or permanent (such as disk).
menu tree
The way in which nested automated attendants are set up.
message categories
Groups of messages in INTUITY AUDIX subscribers’ mailboxes. Categories include new,
unopened, and old for the incoming mailbox and delivered, accessed, undelivered, undeliverable
(not deliverable), and file cabinet for the outgoing mailbox.
message delivery
An optional Lucent INTUITY feature that permits subscribers to send messages to any touch-tone
telephone, as long as the telephone number is in the range of allowable numbers. This feature is
an extension of the AMIS analog networking feature and is automatically available when the AMIS
feature is activated.
Message Manager
See Lucent INTUITY Message Manager.
message-waiting indicator (MWI)
An indicator that alerts subscribers that they have received new voice mail messages. An MWI
can be LED, neon, or audio (stutter dial tone).
minor alarm
An alarm detected by maintenance software that affects less than one fourth of the Lucent INTUITY
ports in service, but has exceeded error thresholds or may impact service.
mirroring
A Lucent INTUITY system feature that allows data from crucial filesystems to be continuously
copied to backup (mirror) filesystems while the system is running. If the system has some problem
where an original filesystem cannot be used, the backup filesystem is placed in service
automatically.
mode code
A string of touch-tones from a MERLIN LEGEND switch. A mode code may send the INTUITY
AUDIX system information such as call type, calling party, called party, and on/off signals for
message waiting lamps.
modem
A device that converts data from a form that is compatible with data processing equipment
(digital) to a form compatible with transmission facilities (analog), and vice-vera.
modular
A term that describes equipment made of plug-in units that can be added together to make the
system larger, improve its capabilities, or expand its size.
modular processor data module (MPDM)
A data device that converts RS-232C or RS-449 protocol signals to digital communications
protocol (DCP) used by System 75/85, Generic1, and Generic 3 switches. MPDMs may connect
Lucent INTUITY to a switch DCIU or SCI link or connect terminals to a switch port card.
MPDM
See modular processor data module.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-17
multilingual feature
An INTUITY AUDIX feature that allows up to nine simultaneously-active announcement sets on the
system. With this feature, each INTUITY AUDIX mailbox can be administered so that subscribers
can hear prompts in the language of their choice.
MWI
See message-waiting indicator.

N
networking
See INTUITY AUDIX Digital Networking .
networking prefix
A set of digits that identifies a Lucent INTUITY machine.
night attendant
The automated attendant created on a MERLIN LEGEND switch that automatically becomes active
during off-hours. The night attendant substitutes for one or more daytime attendants.
not deliverable message
A voice mail message that could not be delivered after a specified number of attempts. This
usually means that the subscriber’s mailbox is full.

O
on-line help
A Lucent INTUITY feature that provides information about Lucent INTUITY user interface screens by
pressing a predetermined key. See also help .
operating system (OS)
The set of programs that runs the hardware and interprets software commands.
option
A choice selected from a menu, or an argument used in a command line to modify program output
by modifying the execution of a command. When you do not specify any options, the command
will execute according to its default options.
OS
See operating system.
outcalling
A Lucent INTUITY feature that allows the system to dial subscribers’ numbers to inform them they
have new messages.
outgoing mailbox
A storage area for subscribers to keep copies of messages for future reference or action.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-18

P
parallel transmission
The transmission of several bits of data at the same time over different wires. Parallel transmission
of data is usually faster than serial transmission.
password
A code assigned to every Lucent INTUITY terminal user and INTUITY AUDIX subscriber for security
reasons. After dialing the system, subscribers must dial their personal password correctly to log
on. Passwords are also assigned to local and remote networked machines to identify the
machines or the network. See also login.
password aging
An INTUITY AUDIX feature that allows administrators to set a length of time after which a
subscriber’s password expires. The subscriber is then forced to change the password.
PBX
See private branch exchange.
PDM (processor data module)
See modular processor data module (MPDM).
peripheral device
Equipment external to the Lucent INTUITY cabinet, such as printers or terminals, necessary for full
operation and maintenance of the Lucent INTUITY system. Also called peripherals.
personal directory
An INTUITY AUDIX feature allowing each subscriber to create a private list of customized names.
personal fax extension
See secondary extension.
pinouts
The signal description per pin number for a particular connector.
port
A connection or link between two devices, allowing information to travel to a desired location. For
example, a switch port connects to a Lucent INTUITY voice port to allow a subscriber to leave a
message.
priority call answer
An INTUITY AUDIX feature that allows callers to designate a call answer message as a priority
message. To make a message priority, the caller presses 2 after recording the message.
priority messaging
An INTUITY AUDIX feature that allows some subscribers to send messages that are specially
marked and preferentially presented to recipients. See also priority outcalling .
priority outcalling
Works with the priority messaging feature by allowing the message recipient to elect to be notified
by outcalling only when a priority message has been received. See also priority messaging .
private branch exchange (PBX)
A private switching system. See also switch.
private mailing list
A list of voice mail addresses that only the owning subscriber can access.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-19
private messaging
A feature of INTUITY AUDIX that allows a subscriber to send a voice mail message that cannot be
forwarded by the recipient.
processor data module (PDM)
See modular processor data module (MPDM).
processor interface (PI)
A System 75, Generic 1, Generic 3i, Generic 3s, and Generic 3vs switch data link. Also called
processor interface board (PIB).
programmed function key
See function key.
protocol
A set of conventions or rules governing the format and timing of message exchanges (signals) to
control data movement and the detection and possible correction of errors.
public mailing list
A list of voice mail addresses that any INTUITY AUDIX subscriber can use if that subscriber knows
the owner’s list ID# and extension number. Only the owner can modify a public mailing list.
pulse-to-touchtone converter
A device connected to the switch that converts signals from a rotary phone to touch tones. This
device allows callers to use rotary phones to access options in a subscriber’s mailbox or to access
options in an automated attendant.

R
RAM
See random access memory.
random access memory (RAM)
The primary memory in a computer that can be overwritten with new information.
reboot
See boot.
remote access
Sending and receiving data to and from a computer or controlling a computer with terminals or
PCs connected through communications links.
remote installation
A system, site, or piece of peripheral equipment that is installed in a different location from the host
switch or system.
remote network
A network in which the systems are integrated with more than one switch.
remote service center
A Lucent or Lucent-certified organization that provides remote support to Lucent INTUITY
customers. Depending upon the terms of the maintenance contract, your remote service center
may be notified of all major and minor alarms and have the ability to remotely log into your system
and remedy problems.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-20
remote subscribers
INTUITY AUDIX voice mail subscribers whose mailboxes reside on a remote INTUITY AUDIX Digital
Networking machine.
remote terminal
A terminal connected to a computer over a phone line.
REN
See ringer equivalence number.
reply loop escape
An INTUITY AUDIX feature that allows a subscriber the option of continuing to respond to a
message after trying to reply to a nonsubscriber message.
reply to sender
An INTUITY AUDIX feature that allows subscribers to immediately place a call to the originator of an
incoming message if that person is in the switch’s dial plan.
request to send (RTS)
One of the control signals on a RS-232 connector that places the modem in the originate mode so
that it can begin to send.
restart
A Lucent INTUITY feature that allows INTUITY AUDIX subscribers who have reached the system
through the call answer feature to access their own mailboxes by typing the *R (Restart)
command. This feature is especially useful for long-distance calls or for users who wish to access
the Lucent INTUITY system when all the voice mail ports are busy. Also, the reinitialization of
certain software. For example, restarting the voice system.
restore
The process of recovering lost or damaged files by retrieving them from available backup tapes,
floppy diskette, or another disk device.
retention time
The amount of time voice mail messages are saved on disk before being automatically deleted
from a subscriber’s mailbox.
ringer equivalence number (REN)
A number required in the United States for registering your telephone equipment with the phone
company.
RTS
See request to send .

S
sales representative
An Lucent or Lucent-certified person who assists you in the purchasing, planning, and
implementation of Lucent equipment and solutions.
SCA
See switch communications adapter.
scan
To automatically play voice mail messages, headers, or both.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-21
scheduled delivery time
A time and/or date that an INTUITY AUDIX subscriber optionally assigns to a message that tells the
system when to deliver it. If a delivery time is omitted, the system sends the message immediately.
SCSI
See small computer system interface.
secondary extension
A second, fax-dedicated extension that directs incoming faxes directly into a subscriber’s mailbox
without ringing the telephone. The secondary extension shares the same mailbox as the voice
extension, but acts like a fax machine. Also called personal fax extension.
serial transmission
The transmission of one bit at a time over a single wire.
server
A computer that processes and stores data that is used by other smaller computers. For Lucent
INTUITY Message Manager, INTUITY AUDIX is the server. See also client.
shielded cables
Cables that are protected from interference with metallic braid or foil.
SIMMs
See single in-line memory modules.
simplified message service interface (SMSI)
Type of data link connection to an integrated 1A ESS switch or 5ESS switch in the Lucent INTUITY
system.
single in-line memory modules (SIMMs)
A method of containing random access memory (RAM) chips on narrow circuit card strips that
attach directly to sockets on the CPU circuit card. Multiple SIMMs are sometimes installed on a
single CPU circuit card.
small computer systems interface (SCSI)
An interface standard defining the physical, logical, and electrical connections to computer
system peripherals such as tape and disk drives.
SMSI
See simplified message service interface.
split
Group (or queue) of analog ports on the switch. See also call-distribution group .
subscriber
A Lucent INTUITY user who has been assigned the ability to access the INTUITY AUDIX Voice
Messaging system.
subscriber interface
The devices that subscribers use to access their mailboxes, manage mailing lists, administer
personal greeting, and use other messaging capabilities. Subscriber interfaces include a touchtone telephone keypad and a PC using Lucent INTUITY Message Manager.
surge
A sudden voltage rise and fall in an electrical circuit.
surge protector
A device that plugs into the phone system and the commercial AC power outlet. It is designed to
protect the phone system from high voltage surges that could be damaging to the phone system.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-22
switch
An automatic telephone exchange that allows the transmission of calls to and from the public
telephone network. See also private branch exchange (PBX).
switched access
A connection made from one endpoint to another through switch port cards. This allows the
endpoint (such as a terminal) to be used for several applications.
switch hook
The device at the top of most telephones which is depressed when the handset is resting in the
cradle (on hook). This device is raised when the handset is picked up (the phone is off hook).
switch hook flash
A signaling technique in which the signal is originated by momentarily depressing the switch hook.
switch network
Two or more interconnected switching systems.
synchronous communication
A method of data transmission in which bits or characters are sent at regular time intervals, rather
than being spaced by start and stop bits. See also asynchronous communication.
synchronous transmission
A type of data transmission where the data characters and bits are exchanged at a fixed rate with
the transmitter and receiver synchronized. This allows greater efficiency and supports more
powerful protocols.
system configuration
See configuration.

T
T.30
The standard for Group III fax machines that covers the protocol used to manage a fax session
and negotiate the capabilities supported by each fax endpoint.
tape cartridge
One or more spare removable cartridges required to back up system information.
tape drive
The physical unit that holds, reads, and writes magnetic tape.
TDD
See telecommunications device for the deaf.
telecommunications device for the deaf (TDD)
A device with a keyboard and display unit that connects to or substitutes for a phone. The TDD
allows a deaf or hearing-impaired person to communicate over the phone lines with other people
who have TDDs. It also allows a deaf person to communicate with the INTUITY AUDIX system.
terminal
See display terminal.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-23
terminal type
A number indicating the type of terminal being used to log on to the Lucent INTUITY system.
Terminal type is the last required entry before gaining access to the Lucent INTUITY display
screens.
terminating resistor
A grounding resistor placed at the end of bus, line, or cable to prevent signals from being reflected
or echoed.
tip/ring
A term used to denote the analog telecommunications interface.
tone generator
A device acoustically coupled to a rotary phone, used to produce touch-tone sounds when voice
mail subscribers cannot use a regular touch-tone generating voice terminal.
traffic
The flow of attempts, calls, and messages across a telecommunications network.
translations
Software assignments that tell a system what to expect on a certain voice port or the data link, or
how to handle incoming data. They customize the Lucent INTUITY system and switch features for
users.
troubleshoot
The process of locating and correcting errors in computer programs. Also called debug .

U
UCD
See uniform call distribution.
Undelete
An INTUITY AUDIX feature that allows subscribers to restore the last message deleted. The
subscriber presses * U to restore a deleted message.
undelivered message
A message that has not yet been sent to an INTUITY AUDIX subscriber’s incoming mailbox. The
message resides in the sender’s outgoing message and may be modified or redirected by the
sender.
Unequipped
See equipped/unequipped .
unfinished message
A message that was recorded but not approved or addressed, usually the result of an interrupted
INTUITY AUDIX session. Also called working message.
uniform call distribution (UCD)
The type of call-distribution group (or hunt group) of analog port cards on some switches that
connects subscribers and users to the INTUITY AUDIX system. System 75, Generic 1, Generic 3,
and some central office switches use UCD groups. See also call-distribution group .
UNIX operating system
A multi-user, multitasking computer operating system.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

GL Glossary
GL-24
untouched message
An INTUITY AUDIX feature that allows a subscriber to keep a message in its current category by
using the **H (Hold) command. If the message is in the new category, message-waiting indication
remains active (for example, the message-waiting lamp will remain lit).
U. S. 123
An alternate announcement set in U. S. English whose prompts use numbers, not letters, to identify
phone keypad presses. For example, a prompt might say, “press star three,” instead of, “press
star D.”
user population
A combination of light, medium, and heavy users on which INTUITY configuration guidelines are
based.

V
vector
A customized program in the switch for processing incoming calls.
voice link
The Lucent INTUITY analog connection(s) to a call-distribution group (or hunt group) of analog
ports on the switch.
voice mail
See voice message.
voice mailbox
See mailbox.
voice message
Digitized voice information stored by the Lucent INTUITY system on disk memory. Also called
voice mail.
voice port
The IVC6 port that provides the voice interface between the Lucent INTUITY system and the analog
ports on the switch.
voice terminal
A telephone used for spoken communications with the Lucent INTUITY system. A touch-tone
telephone with a message-waiting indicator is recommended for all INTUITY AUDIX subscribers.
voicing
Either speaking a message into the Lucent INTUITY system during recording, or having the system
playback a message or prompt to a subscriber.
volt
The unit of measurement of electromotive force. One volt is the force required to product a current
of one ampere through a resistance of one ohm.

W
watt
A unit of electrical power that is required to maintain a current of one amp under the pressure of
one volt.

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Index

IN-1

Index
C
A

IN

About this document, xxi
ADAP
command line language, 11-1
defined , 1-1
directory structure, 2-2
diskette contents, 2-3
introduction, 1-1
addrsub command , 13-2
addsub command , 13-4
alogin command , 11-2
AMIS analog networking , 5-31
Argument
command , 11-9
Audiences
this document, xxii
AUDIX forms supported , 1-3
AUTOEXEC.BAT requirements, 2-7
Automatic login, 11-2

B
Backup
daily subscriber traffic , 10-8
daily system traffic , 10-5
hourly system traffic , 10-4
monthly billing data, 10-9
monthly subscriber traffic , 10-6
monthly system traffic , 10-6
retrieved data, 10-3
subscriber site data, 10-10
Bill calculation
monthly, 6-7
Billing
define price breakdown, 6-3
generate reports, 6-8
monthly calculation, 6-7
organization codes, 6-2
prerequisites, 6-2
starting the process, 6-2
Billing reports
detailed individual report, 6-13
detailed individual subscriber report, 6-15
individual bill totals for organization
report, 6-11
organizational summary report, 6-9
overview, 6-1

Call detail recording
data retrieval, 4-14
scheduling retrieval, 8-8
setup parameters, 3-9
changcex, 13-7
changcom, 13-9
changcos, 13-11
changext, 13-13
changmis, 13-15
changmsg , 13-18
changnam, 13-20
changpwd , 13-22
changsub , 13-24, 13-31
changsw, 13-31
changtext, 13-33
Command
addrsub , 13-2
addsub , 13-4
alogin, 11-2
changcex, 13-7
changcom, 13-9
changcos, 13-11
changext, 13-13
changmis, 13-15
changmsg , 13-18
changnam, 13-20
changpwd , 13-22
changsub , 13-24
changtex, 13-33
chgrcom, 13-36
chgrext, 13-38
chgrmach, 13-40
chgrnam, 13-42
delrsub , 13-44
delsub , 13-46
exit status, 11-9
get_cdr, 12-16
getaalar, 12-2
getadJ, 12-7
getalogp , 12-10
getannc , 12-12
getatt, 12-14
getcomm, 12-19
getcos, 12-25
getdir, 12-28
geterror, 12-30
getevent, 12-35
getfeat, 12-39
getfrag , 12-45
getlimit, 12-47
getlist, 12-50
getload , 12-52
getlog , 12-67
getmaint, 12-71
getmlist, 12-75

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Index

IN-2
Command, (continued)
getnet, 12-77
getperf, 12-89
getralar, 12-111
getrem, 12-116
getrlist, 12-122
getrsub , 12-124
getserve, 12-129
getspfea, 12-131
getsub , 12-137
getsys, 12-144
getsysatt, 12-147
getsyscd , 12-151
getsysfe, 12-153
gettlist, 12-159
gettraf, 12-161
login, 11-5
setadj, 13-48
setalogp , 13-51
setscdr, 13-53
summary
modification, 11-24
summary, retrieval, 11-22
Command Line Commands, 11-8
Comments
about this document, xxvi
Community statistics report, 5-28, 5-30
CONFIG.SYS requirements, 2-7
Configuration
hardware, 2-2
Conventions
this document, xxv

D
Daily community statistics report, 5-30
Daily feature statistics report, 5-18
Daily file system usage report, 5-10
Daily load statistics report, 5-21
Daily network load statistics report, 5-25
Daily remote message statistics report, 5-31
Daily special feature statistics report, 5-27
Daily subscriber retrieval
pc2audix, 4-10
Daily subscriber statistics report, 5-34
Daily system attendant report, 5-41
Daily traffic retrieval
pc2audix, 4-6
Data acquisition
problems, A-2
Data files
naming conventions, 10-2
Data management consideration, 3-17
Data management tools, 10-2
Data retention considerations, 1-7

Data retrieval
pc2audix daily subscriber retrieval, 4-10
pc2audix daily traffic retrieval, 4-6
pc2audix hourly traffic retrieval, 4-5
pc2audix monthly subscriber retrieval, 4-8
pc2audix monthly traffic retrieval, 4-7
pc2audix prerequisites, 4-2
pc2audix scheduling , 8-1
Data transfer, 11-11
Data verification
pc2audix local subscribers, 4-11
pc2audix remote subscribers, 4-13
Database
modification, 1-3
dBASE III PLUS
software installation, 2-6
Debug modem connection, A-1
Define billing price breakdown, 6-3
Delete
daily subscriber traffic data, 10-16
daily system traffic data, 10-13
hourly system traffic data, 10-12
monthly billing data, 10-17
monthly subscriber traffic data, 10-15
monthly system traffic data, 10-14
retrieved data, 10-11
Detailed individual billing report, 6-13
Detailed individual subscriber billing
report, 6-15
Direct output, 11-20
Directories
description, 2-3
Directory structure, 2-2
Diskette contents, 2-3
Display local subscriber information, 9-2
Display remote subscribers, 9-6
Displaying scheduled event log , 8-12
Displaying scheduled events, 8-9

E
Editing scheduled event log , 8-11
Editing scheduled events, 8-9
Error
invalid login, A-3
messages, A-2
protocol, A-2
Exit status, 11-9

F
Feature statistics report, 5-15, 5-18
field , 13-15
File naming conventions, 10-2
File system usage report, 5-8, 5-10

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Index

IN-3
Files and directories, 2-3
Forms
descriptions, 1-7
list, 1-4
Forms supported by ADAP, 1-3

G
Generate billing reports, 6-8
get_cdr, 12-16
getaalar, 12-2
getadj, 12-7
getalogp , 12-10
getannc , 12-12
getatt, 12-14
getcomm, 12-19
getcos, 12-25
getdir, 12-28
geterror, 12-30
getevent, 12-35
getfeat, 12-39
getfrag , 12-45
getlimit, 12-47
getlist, 12-50
getload , 12-52
getlog , 12-67
getmaint, 12-71
getmlist, 12-75
getnet, 12-77
getperf, 12-89
getralar, 12-111
getrem, 12-116
getrlist, 12-122
getrsub , 12-124
getserve, 12-129
getspfea, 12-131
getspfeat, 12-131
getsub , 12-137
getswitc , 12-142
getswitch, 12-142
getsys, 12-144
getsysat, 12-147
getsysatt, 12-147
getsyscd , 12-151
getsyscdr, 12-151
getsysfe, 12-153
gettlist, 12-159
gettraf, 12-161
Glossary, GL-1
Graphical output, 3-16
Graphical output for ADAP, 1-1

H
Hardware
configuration, 2-2
installation, 2-1
Help
online, 3-15
troubleshooting , A-1
Hourly community statistics report, 5-28
Hourly feature statistics report, 5-15
Hourly file system usage report, 5-8
Hourly load statistics report, 5-19
Hourly network load statistics report, 5-23
Hourly special feature statistics report, 5-26
Hourly traffic retrieval
pc2audix, 4-5
How ADAP works, 1-2
How to use pc2audix, 3-15
How to use this document, xxiv

I
Individual bill total for organization report, 6-11
Individual subscriber billing report, 6-15
Input
file, 11-16
keyboard , 11-18
redirect, 11-18
redirect file, 11-16
Installation
dBASE III PLUS software, 2-6
diskette contents, 2-3
pc2audix software, 2-5
prerequisites, 2-1
Stella Business Graphics, 2-6
Interrupting ADAP commands, 11-8
Interrupting pc2audix, 3-16

L
Lengths of program names, 11-1
List local subscriber information, 9-4
List remote subscribers, 9-7
List subscriber threshold exceptions, 7-7
List subscribers over specified billing
amount, 7-3
List subscribers with usage over specified
amount, 7-5
Load statistics report, 5-19, 5-21
Local subscriber information, 9-2
Login, 11-2, 11-5
Logout, 11-8

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Index

IN-4

M
Manual login, 11-5
Message Delivery, 5-31
Modem connection
debug , A-1
Modification command summary, 11-24
Monthly bill calculation, 6-7
Monthly remote messages statistic report, 5-32
Monthly subscriber statistics report, 5-36
Monthly system attendant report, 5-44
Monthly traffic retrieval
pc2audix, 4-7, 4-8

N
Names
lengths of programs, 11-1
Network load statistics report, 5-23, 5-25

O
Online help , 3-15
Option
hardware, 2-1, 2-2
software, 2-1
Organization
this document, xxii
Organization codes, 6-2
Organization summary billing report, 6-9
Output
data formats, 11-18
dBASE format, 11-20
direct, 11-20
redirecting to a file, 3-16
redirecting to screen, 3-15

Pc2audix, (continued)
displaying the scheduled event log , 8-11
editing scheduled events, 8-9
graphical output, 3-16
hourly traffic retrieval, 4-5
initiating data retrieval, 4-4
interrupting , 3-16
monthly subscriber retrieval, 4-8
monthly traffic retrieval, 4-7
online help , 3-15
redirecting output to a file, 3-16
redirecting output to screen, 3-15
required subdirectories, 3-3
retrieval overview, 4-1
root menu, 3-13
scheduling data retrieval, 8-1
setup parameters, 3-4
site specific data, 9-1
starting the program, 3-12
traffic reports, 5-1
usage considerations, 3-17
using , 3-1
verify local subscribers, 4-11
verify remote subscribers, 4-13
pc2audix
back up retrieved data, 10-3
data management functions, 10-1
data management tools, 10-1
delete retrieved data, 10-11
file naming conventions, 10-2
installation, 2-5
restore backed up data, 10-18
starting data management, 10-2
Peak port usage report, 5-5
Performance statistics, 4-15, 8-4, 12-89
Prerequisite skills for using ADAP, xxii
Prerequisites
installation, 2-1
Price breakdown
billing , 6-3
Problems
automatic login, A-3
data acquisition, A-2
Program name lengths, 11-1
Program software installation, 2-4

P
PATH requirements, 2-7
Pc2audix
billing calculation, 6-7
billing prerequisites, 6-2
billing report generation, 6-8
billing reports, 6-1
call detail recording data retrieval, 4-14
daily subscriber retrieval, 4-10
daily traffic retrieval, 4-6
data retrieval, 4-1
define billing price breakdown, 6-3
defined , 1-1

R
Reader comments
how to make, xxvi
Reboot, 2-5
Redirect input, 11-18
Redirecting output
to a file, 3-16
to screen, 3-15
Related resources, xxvi
Remote message statistics report, 5-31, 5-32

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Index

IN-5
Remote subscribers, 9-6
list all fields, 9-7
Remote traffic report, 5-39
Requirements
hardware and software, 2-1
Restore
backed up data, 10-18
daily subscriber traffic data, 10-23
daily system traffic data, 10-20
hourly system traffic data, 10-19
monthly billing data, 10-24
monthly subscriber traffic data, 10-22
monthly system traffic data, 10-21
subscriber site data, 10-25
Retention
AUDIX data, 1-7
Retrieval command summary, 11-22
Retrieval commands, 11-9
Retrieved data
back up , 10-3
delete, 10-11
restore, 10-18
Return codes, 11-21
Root menu options, 3-13

S
Scheduled event log
displaying , 8-11
editing , 8-11
Scheduled events
displaying , 8-9
editing , 8-9
Scheduling call detail recording retrieval, 8-8
Scheduling mode, 8-2
Scheduling pc2audix events, 8-2
Searches
pc2audix data searches, 7-1
Service marks, xxv
Session usage report, 5-12
setadj command , 13-48
setalogp command , 13-51
setscdr command , 13-53
Setup parameters
call detail recording , 3-9
modifying , 3-11
pc2audix, 3-4
Sitespecific data, 9-1
Skills required
this document, xxii
Software
diskettes, 2-3
installation, 2-1, 2-3
Special feature statistics report, 5-26, 5-27
Starting data management functions, 10-2
Starting pc2audix, 3-12

Statistics
transmission, 11-11
Status
exit, 11-9
Stella Business Graphics
for graphical output, 1-1
software installation, 2-6
usage defined in setup parameters, 3-16
Subscriber billing report, 6-15
Subscriber statistics report, 5-34, 5-36
Subscriber usage
list, 7-5
list threshold exceptions, 7-7
Subscribers
list bills over specified amount, 7-3
Syntax
this document, xxv

T
Terminal interactions, A-2
Timeouts, A-2
Trademarks, xxv
Traffic reports
average port usage, 5-3
daily file system usage, 5-10
daily system attendant report, 5-41
hourly file system usage, 5-8
monthly system attendant report, 5-44
overview, 5-1
peak port usage, 5-5
prerequisites, 5-2
producing , 5-2
remote traffic , 5-39
session usage, 5-12
view AUDIX traffic data, 5-14
Transfer of data, 11-11
Transmission statistics, 11-11

U
Upgrade
PC2AUDIX, 3-11
User interface
pc2audix, 1-1
Using scheduling mode, 8-2

AUDIX Administration and Data Acquisition Package 585-302-502

Issue 14
May 1999

Index

IN-6

V
Verify remote subscribers
pc2audix, 4-13
View
AUDIX traffic data, 5-14
daily community statistics, 5-30
daily feature statistics, 5-18
daily load statistics, 5-21
daily network load statistics, 5-25
daily remote message statistics, 5-31
daily special feature statistics, 5-27
daily subscriber statistics, 5-34
hourly community statistics, 5-28
hourly feature statistics, 5-15
hourly load statistics, 5-19
hourly network load statistics, 5-23
hourly special feature statistics, 5-26
monthly remote message statistics, 5-32
monthly subscriber statistics, 5-36



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.4
Linearized                      : No
Page Count                      : 488
Page Mode                       : UseOutlines
Page Layout                     : SinglePage
Producer                        : 
Keywords                        : 
Mod Date                        : 2002:01:13 18:24:17-06:00
Author                          : EZ Manuals
Creation Date                   : 0-01-01T00:00:00Z
Subject                         : 
Modify Date                     : 2002:01:13 18:24:17-06:00
Create Date                     : 0-01-01T00:00:00Z
Metadata Date                   : 2002:01:13 18:24:17-06:00
Title                           : AUDIX® Administration and Data Acquisition Package
Creator                         : EZ Manuals
Description                     : 
EXIF Metadata provided by EXIF.tools

Navigation menu