Lucent Technologies Audix Administration And Data Acquisition Guide

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-9 Command Line Commands 
11
Command Format
Datab ase retrieval and  mod ific ation c ommand s are assoc iated  with sp ec ific  
voic e mail system ad ministrative and  maintenanc e sc reens that are sup p orted  b y 
ADAP. Eac h c ommand  option b eg ins with a d ash, followed  immediately b y a 
one-letter op tion id entifier. If the op tion requires an arg ument, the arg ument 
immed iately follows the op tion letter. You 
can insert spac es b etween the op tion 
and  the arg ument for read ab ility — they will b e ig nored .
Optional arg uments are enc losed b y sq uare b rac kets ([  ... ]). 
For examp le, you mig ht enter the gettraf
 c ommand  as follows: 
gettraf -f month -d 1294 -i
In the previous gettraf
 line c ommand ,
 
The following  op tions are c ommon to b oth retrieval and  mod ific ation c ommand s: 
-fOption flag  for sp ec ifying either month
 or day
monthArg ument sp ec ifying  that the monthly traffic  sc reen d ata should  
b e ac cessed
-dOption flag  for sp ec ifying date
1294Arg ument id entifying  the month of traffic  to b e ac c essed  (Dec . 
1994)
-iOption allowing  ind ivid ual extensions to b e entered  interac tively 
from the keyb oard
-V
Version flag . When you use this op tion, the ADAP version 
numb er ap p ears and  the c ommand  exits.
-w
Exit status flag . This op tion writes a one-line summary of 
the exit status of this c ommand  into a file. Sc reen retrieval 
and nonsubsc riber d atab ase mod ific ation c ommand s 
write to form_req .rc ; sub sc rib er d atab ase mod ific ation 
c ommand s write to main.rc ; alogin
 writes to alog in.rc ; 
and get_cdr
 writes to g etc dr.rc . 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-10 Command Line Commands 
11
-r
Release numb er flag . Must b e followed by the release 
numb er, whic h id entifies 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 I
NTUITY AUDIX system
(I-r5.0, I-r4.0, I-r3.3, I-r3.2, or I-r2.0) with whic h it is 
c ommunic ating . The d efault for DEFINITY AUDIX is 
D-r3.2. The d efault for I
NTUITY AUDIX is I-r5.0.
When ac cessing an R1 AUDIX System or a DEFINITY AUDIX System other 
than release 3.2, you may want to c hang e the d efault release value to 
c orresp ond  to the release of that AUDIX system. This allows you to enter 
retrieval and  mod ify c ommand s for this AUDIX system without using  the
-r release
 op tion. Prior to exec uting  retrieval and  mod ify c ommand s, set the 
AUDIX_RELEASE environment variab le to the release value you want b y 
entering  one of the c ommand s listed  b elow:
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 c lear this environment variable, enter the following  c ommand :
           set AUDIX_RELEASE= 
without a release value. This restores D-r3.2 as the d efault release value.
Similarly, when accessing an I
NTUITY AUDIX system other than release I-r5.0, 
you may want to c hang e the d efault release value to c orresp ond to the release 
of that AUDIX system. This allows you to enter retrieval and  modify c ommand s 
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
Using the ADAP Command Line Language 
11-11 Command Line Commands 
11
  When using the -v
 op tion or p ressing  v
 in c ommunic ating  the voic e mail 
  system,  the following  information ap p ears in the following  seq uenc e: 
You d o this in a manner similar to the ab ove. Prior to exec uting  retrieval and  
mod ify c ommand s, set the AUDIX_RELEASE environment variab le to the 
release value you want b y entering  one of the c ommand s 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 c lear this environment variable, enter the following  c ommand :
           set AUDIX_RELEASE= 
without a release value. This restores I-r5.0 as the d efault release value.
-v
                             Verb ose flag. This op tion d isp lays information ab out the
                                d ata transfer from the voic e mail system to ADAP when
                                the d ata transfer is c omp lete.
The following op tions are availab le for b oth retrieval and  mod ific ation 
command
s
q                             
Press during  transmission to quit the transfer g rac efully.
                               This may take some time. 
v                             
Press d uring  transmission to 
view the c urrent
                               
transmission statistic s on the sc reen.
NOTE:                        
For sc reens with very little d ata, and , therefore, a very rap id transfer rate, the 
transmission may c omp lete b efore you are ab le to p ress q
 or v
.
DEFINITY and I
NTUITY AUDIX 
Systems R1 AUDIX Systems
Elap sed  time of the full d ata 
transmissionNumb er of p ac kets sent 
Number of files/forms transmitted  Numb er of p ac kets rec eived
Total c harac ters in the files/forms Numb er of p ac kets retransmitted  d ue 
to p ac ket/p rotoc ol errors 
Total number of b ytes rec eived   No. of c harac ters of sc reen d ata 
received   
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-12 Command Line Commands 
11
Record Description Tables
The ADAP c ommand s ac c ep t inp ut and  c reate outp ut in rec ord  formats. This 
sec tion d esc ribes the inp ut and  outp ut rec ord formats used  b y these c ommand s. 
The tab les in Chapter 12, Command  Line Datab ase Retrieval Commands
, and  
Chapter 13, Command  Line Datab ase Mod ific ation Command s
, tell you what 
the ADAP p rog ram ac c ep ts as inp ut and  what to exp ec t from the outp ut. The 
tab le b elow is an examp le outp ut layout for the getmlist
 c ommand . Total number of b ytes sent  Numb er of sc reens rec eived
Number of p ac kets sent Effec tive c harac ter rec ep tion rate in 
b its p er sec ond  (b /s) 
Number of p ac kets rec eived   Elapsed  time of the full d ata 
transmission
Number of damaged packets 
received
Number of time-outs waiting  for 
packets
Number of packets retransmitted due 
to p ac ket/p rotoc ol errors 
Number of wind ow slots used
Number of c omp ressed  c harac ters
Effec tive c harac ter transmission rate 
in b its p er sec ond  (b /s) 
                            Field      Voice Mail Versions
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
SystemDEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System
1 mac hine name C 10 r1v3+ D-r1.0+ I-r2.0+
2 voic e id C 3 r1v3+ D-r1.0+ I-r2.0+
3 mac hine typ e C 12 r1v4+ D-r1.0+ I-r2.0+
4 c allbac k numb er K 10 r1v8+ D-r3.0+
DEFINITY and INTUITY AUDIX 
Systems R1 AUDIX Systems 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-13 Command Line Commands 
11
All rec ord s c onsist of field s joined  b y field  sep arators and  terminated  with a 
 c harac ter. Eac h tab le row d esc rib es the following  field  c harac teristic :
Th e  getmlist
 c ommand  d epic ted  ab ove mig ht retrieve a rec ord , for DEFINITY 
AUDIX R1.0 (D-r1.0), that looks like this:
Seattle,0,audix
 
The machine name is Seattle
, the voic e id  is a 0
, and  the mac hine typ e is an 
audix
. A c allb ac k number is not rep orted ; the tab le indic ates that a c allb ac k 
numb er field  is outp ut for DEFINITY AUDIX only when ADAP is interac ting  with 
releases D-r3.0 and  b eyond . 
Notic e that eac h field in the outp ut is sep arated  b y a c omma, the d efault outp ut 
field separator.Seq. No.
Sequenc e of the field s within the rec ord .
Field Name
Id entifies the field .
Type
Id entifies field  typ e: c harac ter, numeric , d ate, time, d ig it 
sequence, and logical.
Max. Width
Larg est size of the field , in c harac ters.
VOICE MAIL 
VERSIONSEac h c olumn id entifies whic h voic e mail version(s) the 
field s p ertain to (app ear in the outp ut or are allowed  in 
the inp ut).
NEWLINE
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-14 Command Line Commands 
11
Field Types
There are six field  typ es used  in the ADAP c ommand  line inp ut and  outp ut 
rec ord s.
C (Character)
Set of c harac ters enc losed  b y d elimiters. The d efault 
d elimiter is the d oub le q uote (). Any c harac ter 
(alp hab etic , numeric , sp ec ial c harac ter, or blank) may 
b e in the string . The maximum wid th c olumn sp ec ifies the 
maximum numb er of c harac ters that may b e in the 
c harac ter string .
N (Numeric)
Contains a p ositive or negative integ er or floating  p oint 
numb er. A minus sig n (-) p rec ed es a neg ative numb er. 
The maximum wid th sp ec ifies the larg est numb er of 
d ig its in the field . 
If the maximum wid th for the field  c ontains a d ec imal 
p oint, this ind ic ates that the numeric  field  is a floating  
p oint value. For examp le 3.2 means that there c an b e up 
to three d ig its b efore the d ec imal p oint and  up  to two 
d ig its after the d ec imal.
NOTE:
If numeric  d ata is unavailab le from the voic e mail system, 
the system may p lac e a non-numeric  warning string  
(suc h as Traffic  d ata unavailab le) on a numeric  field  of 
the sc reen that ADAP is attemp ting  to ac c ess. Und er 
these c ond itions, ADAP is exp ec ting  to outp ut a numeric  
value when the voic e mail p latform is p rovid ing  a 
non-numeric  string . The ADAP c ommand  p lac es a -1 into 
the numeric  outp ut field  instead  of any warning  string .
D (Date)
8-digit date field, in 
yyyymmd d  format. dd d efaults to 01, 
if the field provid ed  b y the voic e mail system d oes not 
inc lud e a d ay-of-month. 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-15 Command Line Commands 
11
Voice Mail Version Columns
Eac h tab le c ontains c olumns for the three voic e mail systems that ADAP 
sup p orts. These c olumns identify whic h field s are valid inp ut or exp ec ted  outp ut 
for whic h system release(s). The information in the tab le b elow is an examp le 
only.
 
There are four typ es of entries in the voic e mail version c olumn: a shad ed  b ox, a 
sing le release, a rang e of releases, or an op en end ed  set of releases.
A 
shad ed b ox ind ic ates that the field  d oes not ap p ly to any release of the system. 
For example, the shad ed  b ox shown ab ove means that the field  d oes not exist for 
the getmlist
 c ommand  for the I
NTUITY AUDIX system.
A 
sing le release ind ic ates that the field  is valid  inp ut or outp ut only for that 
p artic ular release. The release p lac ed  in the tab le is the value g iven to the -r
 
op tion of the ADAP c ommand .
A
 rang e of releases for a p artic ular field  means that the field  is valid  inp ut or 
output for any release inc lud ed  in that range. The rang e is inc lusive. For example 
of the rang e that ap p ears in the R1 AUDIX c olumn for the voic e id  field means the 
field  app ears in the c ommand s outp ut only when using  ADAP with AUDIX 
releases r1v2 throug h r1v3.T (Time)
4-d ig it time of day presented  in military format 
hhmm. A 
time field  d oes not c ontain a c olon (:) to sep arate the 
hours and  minutes. Mid nig ht is rep resented  by 0000.
K (Digit 
Sequence)Contains a string  of d ig its, possib le values 0 throug h 9, 
enc losed  in d elimiters. This field typ e is usually used  for 
extensions and  mailb ox p assword s, the numb ers that 
voice mail sub scrib ers enter to acc ess their mailb ox 
c ontents. Sinc e these values are entered  on a telephone 
keyp ad, they are id entified  as field  typ e K. Unlike 
numeric fields, leading zeros are valid; unlike character 
field s, only dig its are valid  within the field .
L (Logical)
Contains 
y or n. Log ic al field s c ontain values that answer 
yes/no q uestions or ind ic ate whether p artic ular features 
are on or off.
                          Field       Voice Mail Versions
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX
SystemDEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System
1 mac hine name C 10 r1v2+ D-r1.0+ I-r2.0+
2 voic e id C 3 r1v2-r1v3 D-r1.0+ I-r2.0+
3 mac hine typ e C 12 r1v4_5+ D-r1.0+ I-r2.0+
4 c allb ac k numb er K 10 r1v8+ D-r3.0+ 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-16 Command Line Commands 
11
Th e  op en end ed  set, is shown b y a release numb er followed  by a p lus (+ ) sig n. 
This means that the p artic ular field  is valid  inp ut or outp ut for the d esig nated  
release and  any later, newer releases. An examp le of an op en end ed  set is the 
r1v4_5+  d esig nation ap p earing  in the mac hine typ e field  row of the rec ord  
layout tab le ab ove. This ind ic ates that the mac hine typ e will ap p ear in the outp ut 
when ADAP is interac ting  with AUDIX releases r1v4_5 and  newer.
Input Records
This sec tion d esc rib es rec ord  formats and  p arameters for the inp ut file.
Input File Format 
You may p rocess multiple voice mail sub scribers b y creating  an inp ut file 
c ontaining  information ab out the subsc rib ers you wish to add , d elete, up d ate, or 
monitor. This file is then used  as inp ut by the d ata retrieval or mod ific ation 
command. 
Certain c ommand s req uire that you use valid  extensions from the voic e mail 
system as inp ut. For examp le, the I
NTUITY or DEFINITY AUDIX Disp lay 
Sub sc rib ers sc reen c onsists of a d ifferent rec ord  of data for eac h sub sc rib er. To 
retrieve a rec ord  for eac h of several sub sc rib ers, you would enter the extension 
numb er for eac h subsc rib er on a sep arate line in the inp ut file. 
Some c ommand s req uire that you sup p ly only the sub sc rib er extension for the 
d ata that you want to retrieve or mod ify. The following  examp le shows a list of 
extensions, eac h on a sep arate line and  c ontaining  from three to 10 d ig its. (On 
any one voic e mail system, all the extensions must b e the same leng th). 
        1234567890 
        2345678901 
        9999999999 
        0011100111 
Bec ause the ADAP software treats extensions as c harac ters instead  of numb ers, 
the lead ing  zeroes in 0011100111 are not lost. 
Other c ommand s req uire that you sup p ly ad ditional information to id entify     
c omp letely  the d ata that you want to retrieve or modify. The following  examp le 
req uires extension and  name for eac h sub sc rib er, d efined  b y d elimiters (
) 
eac h on a sep arate line and c ontaining  from three to 10 d ig its. 
        1234567890,Doe,Mary
        2345678901,Martinez,Bob
        9999999999,Green,Sarah
        0011100111,Jones,David 
Notic e that this is the d ata retrieved  b y the getdir
 c ommand . For examp le, you 
c ould  retrieve the sub sc rib er extension and  name using  getdir
 then use this d ata 
as inp ut for another c ommand . 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-17 Command Line Commands 
11
NOTE:
When c onstruc ting  inp ut rec ord s for ADAP c ommand s, all field s, 
reg ard less of typ e, must b e enc losed  in d oub le q uotation marks and  
sep arated  b y c ommas. The rec ord s must b e terminated  with a NEWLINE. 
These rules hold  true whether the inp ut is red irec ted  from a file or entered  
interac tively from the keyb oard  thoug h the use of the -i
 op tion.
Optional Input Fields
A field  name enc losed in square b rac kets, that is [ ....] , ind ic ates an op tional inp ut 
field . You d o not have to p rovid e a value for this input field when using that 
p artic ular ADAP c ommand . If you wish not to p rovid e a value for this inp ut field  
b ut want to g ive a value for a field  later in the inp ut field  seq uenc e, you must 
insert a plac ehold er set of d oub le q uotes () d enotes a null string ) and  a field  
sep arator (a c omma) into the inp ut rec ord  in the p lac e of this inp ut field .
The null string  and  c omma serve as a p lac ehold er so you c an tell ADAP you want 
to skip  the field  and  g o to a field  later in the inp ut seq uenc e. The ADAP c ommand  
may then d etermine the p urp ose of the value later in the inp ut rec ord . If you wish 
to p rovid e a value for the nth inp ut field , you must have p rovided  values or 
p lac ehold ers for all p revious (n-1) fields in the input rec ord . If you wish to omit all 
op tional field s, you need  only p rovid e the req uired  field s; p lac ehold ers are not 
nec essary.
When you omit op tional field s, ADAP d oes not p lac e a value into the 
c orresp ond ing field  on the voic e mail form. It allows the voic e mail mac hine to 
p rovid e a d efault value in the c ase of ad ding  loc al or remote sub sc rib ers. When 
c hang ing  existing  sub sc rib ers, omitting  op tional field s c auses the c orresp onding  
information on the voic e mail mac hine to b e skip ped , leaving  intac t any value that 
may already be there.
Input of Name or Extension
(DEFINITY/I
NTUITY AUDIX)
S
ome inp ut rec ords format tab les ind ic ate that a name and  an extension should 
b e p rovid ed . There is some flexib ility when an ADAP is c ommunic ating  with a 
DEFINITY AUDIX or I
NTUITY AUDIX system. When an ADAP c ommand  for a 
DEFINITY AUDIX or I
NTUITY AUDIX system ac c ep ts b oth a name and  extension in 
an inp ut rec ord , an emp ty set of d oub le q uotes may b e p lac ed  for either the 
name or the extension. Both d ata items need not be p rovid ed .
If only the name is p rovid ed , the c ommand  uses the name; if only the extension is 
p rovid ed in the inp ut rec ord , the c ommand  uses the extension. If b oth the name 
and  extension are sp ec ified  in an inp ut rec ord , the name is ignored and  the 
extension is emp loyed  in the transac tion. For op erations whic h c hang e the name 
or extension, these easements ap p ly only to the old  name and  old  extension. 
These g uid elines d o not ap ply to interac tions with R1 AUDIX systems. 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Using the ADAP Command Line Language 
11-18 Command Line Commands 
11
Redirecting Input from Files 
Onc e you have c onstruc ted  an inp ut file, you c an use it to retrieve d ata. For 
examp le, if you wanted  to retrieve rec ord s for all sub sc rib ers on the voic e mail 
system, using  an inp ut file c alled  d ir.d at, you c ould  enter the following  c ommand .
      getsub < dir.dat > sub.dat
 
Sub sc rib er extension input is sup p lied  to the getsub
 c ommand  from the d ir.d at 
file. This file c ontains the extensions of all sub sc rib ers on the voic e mail system 
and  has b een formatted  c orrec tly by the getdir
 c ommand . The getsub
 
c ommand  (and  all other c ommand s req uiring  a subsc rib er extension numb er) 
retrieves d ata for a sub sc rib er when the sub sc rib er’s extension number is 
entered . ADAP writes eac h returned  sub sc rib er rec ord  to the sub .d at file. 
Entering Data from the Keyboard 
You may enter d ata d irec tly from the keyboard  b y inc lud ing the -i
 op tion on the 
c ommand  line. To ind ic ate that you have finished  entering  d ata while in 
interac tive mod e, p ress  , followed  b y  .   is the MS-DOS 
end -of-file (EOF) c harac ter. 
For example: 
delsub -i
 
Doe, John
, 0123456789
 
Output Records
The following sec tion d esc rib es the outp ut rec ord  format.
Output Record Format
All data items in outp ut rec ord s are sep arated  b y an outp ut field  sep arator (OFS). 
The default OFS is a c omma. All character (C), digit sequence (K), and logical (L) 
fields are enclosed in delimiting characters when appearing in output rec ords.
NOTE:
Field s that d o not exist for a g iven release of the voic e mail system may be 
inc lud ed  in outp ut for c omp atib ility with other releases. Those field s c ontain 
a 0 or . 
Ctrl-zRETU RNCtrl-z
RETU RN
Ctrl-zRETU RN