Lucent Technologies Audix Administration And Data Acquisition Guide

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-25 changsub 
13
Errors 
If either the name or extension d oesn’t b elong to a valid system subsc riber, an 
error message d isp lays. If more rec ord s exist in the inp ut file (

						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-26 changsub 
13
Note that the ord er and  func tion of the field s is the same for INTUITY AUDIX, 
DEFINITY AUDIX, and  R1 AUDIX Systems, however some field  sizes d iffer. This 
is b ec ause I
NTUITY AUDIX and  DEFINITY AUDIX Systems sometimes store a 
whole word  in the field, where the R1 AUDIX System uses an abb reviation. 
As an example, the DEFINITY AUDIX System uses 
lifo or fifo for inc oming  
mailb ox retrieval ord er. For Inc oming  Mailbox Lifo/Fifo, the R1 AUDIX System 
stores just 
l or f in the field . DEFINITY AUDIX System mac hines translate an l or f 
value sent with changsub
 for this field  into the word s, 
lifo or fifo, resp ec tively; 
and  when the data is retrieved  with getsub
 from the DEFINITY AUDIX Systems, 
the word s 
lifo or fifo are sent. 
You may leave any of the field s unaltered  b y p lac ing between the c omma 
d elimiters a suc c essive p air of d oub le q uotes. To erase a field , p lac e into the 
input rec ord  a string  of sp ac es equal in size to the wid th of the field. (For 
examp le, to b lank the c ontents of the Misc ellaneous field , p lac e a string  of 11 
sp ac e c harac ters enc losed  in d oub le q uotes into the inp ut rec ord.) 
To c hange a sub sc rib er’s name, p lac e the old  name into the Sub sc riber Name 
field  and  the new name into the New Sub sc rib er Name field . After the changsub
 
op eration, the sub sc rib er is then keyed  b y the new name. The next time getsub
 
is emp loyed to retrieve sub sc rib er information, the new name ap p ears as the first 
field  in the outp ut rec ord . 
30 [ g uaranteed  spac e] N 4 r1v5+ D-r1.0+ I-r2.0+
31 [ new sub sc rib er name] C 29 r1v5+ D-r1.0+ I-r2.0+
32 [ new extension] K 10 r1v5+ D-r1.0+ I-r2.0+
33 [ loc ked] L 1 r1v5+ D-r1.0+ I-r2.0+
34 [ c ommunity id ] N 2 r1v5+ D-r1.0+ I-r2.0+
35 [ b road c ast mailbox] L 1 r1v5+ D-r1.0+ I-r2.0+
36 [ p riority messages] L 1 r1v5+ D-r1.0+ I-r2.0+
37 [ b road c ast permissions] C 5 r1v5+ D-r1.0+ I-r2.0+
38 [ end  of messag e warning time] N 2 r1v6+ D-r1.0+ I-r2.0+
39 [ c a lang uage c hoic e] L 1
D-r3.0+ I-r3.2+
40 [ log in announc ement set] C 14
D-r3.0+ I-r3.2+
41 [ c a p rimary announc ement set] C 14
D-r3.0+ I-r3.2+
42 [ c a sec ond ary announc ement set] C 14
D-r3.0+ I-r3.2+
43 [ IMAPI ac c ess] L 1
D-r3.1+ I-r3.2+
44 [ IMAPI voic e file/messag e transfer] L 1
D-r3.1+ I-r3.2+
45 [ sec ond ary extension] K 10
I-r3.3+
46 [ FAX c reation] L 1
I-r3.3+
47 [ trusted  server ac c ess] L 1
I-r4.0+ FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX 
System 
DEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-27 changsub 
13
To c hange a sub sc rib er’s extension, p lac e the old extension into the Extension 
field  and  the new extension into the New Extension field . After the changsub
 
op eration, the sub sc rib er is then keyed  b y the new extension. The next time 
getsub
 is emp loyed to retrieve subsc rib er information, the new extension 
ap p ears as the sec ond  field  in the outp ut rec ord . 
The value for Class of Servic e may b e the name or numb er of any c lass of servic e 
known to the voic e mail mac hine, inc lud ing 
custom. 
The ADAP c ommand  d oes not verify inp ut for d ata c orrec tness, a task p erformed  
on the AUDIX sid e of the c onnec tion. However, it p asses along  any error 
messag es it rec eives from the AUDIX System. The following tab le is a g uid e for 
input to field s that d o not simp ly ac c ep t text or numb ers up  to a p artic ular limit, 
nor are yes/no ac tivations: 
For more d etails on the valid  field  values and  their meaning s, p lease c onsult the 
ap p rop riate sc reens referenc e manual. For R1 AUDIX Systems, c onsult the 
sub sc rib er : loc al sc reen in the 
AUDIX Forms Referenc e, 585-305-209. For 
DEFINITY AUDIX Systems, c onsult the Change Sub sc rib er sc reen in 
DEFINITY 
AUDIX - Sc reens Referenc e
, 585-300-207.
Output Format
The items described in this sec tion are directed to standard output. The location 
of any newline c harac ters in the outp ut is unp red ic tab le. Up on start-up , the 
p rog ram p rints a head er dec laring  the func tion and  version of the p rog ram:
SUBSCRIBER CHANGE ROUTINE 
(
< ADAP version name>)
Field description
Acceptable values 
for AUDIX System
Acceptable values for 
DEFINITY/I
NTUITY AUDIX 
Systems
ad d ressing formatn or ename or extension
CA permissionsa, c, p, or nauto-attend ant,
bulletin-board,
call-answer, or none
inc oming  mailb ox lifo/fifol or flifo or fifo
inc oming  mailb ox ord erthe letters n, u, and  o,
in any ord erthe letters n, u, and  o,
in any ord er
outg oing mailb ox lifo/fifol or flifo or fifo
outg oing  mailb ox ord erthe letters f, u, n, d, and  a, 
in any ord erthe letters f, u, n, d, and  a, in 
any ord er
broadcast permissionsv, l, b, or nvoic e, log in, both or none 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-28 changsub 
13
If the p rogram is suc c essful in parsing  the inp ut rec ord , it ec hoes the values it 
sees for eac h of the fields. In interac ting  with all voic e mail releases, the outp ut 
for eac h inp ut rec ord  c onsists of the c ommand  statistic s 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 c ommunic ating  with a DEFINITY AUDIX System, the following  add itional 
c ommand  statistic s ap p ear in the outp ut for eac h inp ut rec ord . These items 
ap p ear after the ab ove items.
CA language choice = _; login annc set = ________ ;
CA primary annc set = _____; CA secondary annc set = ______ ;
IMAPI access = _____; IMAPI voice file transfer = ______;
Th e  I
NTUITY AUDIX System inc lud es the following  ad d itional 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 prog ram relays the inp ut rec ord to the voic e mail mac hine and  attemp ts 
the c hang e operation. If the transac tion with the voic e mail mac hine was not 
suc c essful, the p rog ram p asses along  the error messag e rec eived  from the voic e 
mail system. If the transac tion was suc c essful, the outp ut shows (reflec ting  new 
extension, if c hanged ):
___: CHANGED EXT __________ 
The first b lank of the ab ove is rep lac ed  with the line numb er of the p roc essed 
input rec ord . The sec ond  b lank holds the extension numb er of the sub sc riber 
mod ified . If the string  CHANGED EXT followed  b y a sp ac e and the desired  
extension d oes not ap p ear in the outp ut, the op eration has failed .
Up on termination, the p rog ram p rints a summary of the numb er of sub sc rib ers 
suc c essfully mod ified :
 subscribers changed 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-29 changsub 
13
If the numb er p rinted  does not matc h the numb er of inp ut rec ords, one or more of 
the req uested  c hang e op erations has failed .
Example 
The following  c ommand  c hang es two sub sc rib ers on a DEFINITY AUDIX System: 
where sub .d at c ontains: 
Mozart, Wolfgang A,5803,heavy10   
Bach, Johann S,5804,,,,,,,,, y,,,f,,, 
30  
The following data appears on standard output: 
SUBSCRIBER CHANGE ROUTINE 
(
< ADAP version name>)
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 = ; 
changsub -r D-r3.2 < sub.dat RETU RN
NEWLINE
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-30 changsub 
13
2: CHANGED EXT 5084 2 subscriber(s) changed 
In this examp le the exec ution of c hang sub has c hang ed  Mozart’s c lass of 
servic e to heavy10
 from whatever it was b efore. All attrib utes c ontrolled  b y the 
c lass of servic e are c hang ed  to the values assoc iated  with the c lass of servic e 
named  heavy10
. 
Bac h may now use the outc alling  feature, his inc oming  messag es are now 
ord ered  as first-in, first-out, and  his old  messag es are now retained  for 30 d ays. 
These c hang es overwrite the values Bac h p reviously had . The AUDIX System 
automatic ally c hang es Bac h’s c lass of servic e field  to custom
 if these values 
d iffer from the attrib utes of a named  c lass of servic e that he had  b efore running  
c hang sub . Note that for Bac h’s inp ut rec ord , many c harac ter string  fields were 
skipp ed  and  there is a new retention time numeric  field .  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-31 changsw 
13
changsw
Chang e sub sc rib er switc h number 
Syntax 
changsw
 [-r release] [-v
] [-w
] [-V
] [-i
] [<  ifile] [> ofile]
Description 
This c ommand  mod ifies subsc riber switc h numb ers in the c urrent d atab ase of 
the voic e mail system. Use the name, extension, and  new switc h numb er for 
eac h sub sc rib er as inp ut. Command  statistic s are written to stand ard  outp ut. 
-r
Release flag ; must b e followed  b y 
release. 
releaseSets d ata for the sp ec ified  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 I
NTUITY AU D I X Sys t e m ,  t h e  
d efault is I-r5.0. 
-v
Writes transfer statistic s to the sc reen at the end  of the transfer. 
Unless -i
 is sp ec ified , p ressing  v
 while the c ommand is exec uting  
sends the upd ated  transfer status to the sc reen. 
-w
Writes a one-line summary of the exit status of this c ommand  into 
the file, main.rc
. 
-V
Writes the ADAP version numb er for this c ommand  and exits 
without transferring  any sc reens d ata. 
-i
Turns off the searc h for p ossib le sub seq uent entry of the v
 and  q
 
(q uit) op tions. Otherwise, if you typ e ahead , you may lose 
c harac ters. 
If you d on’t sp ec ify -i
, you must sp ec ify an input file (
< ifile) from 
whic h the names, extensions, etc ., will b e read . 
< 
ifileName of an inp ut file you have c reated . The filename must b e 
p rec ed ed  b y the symb ol < . 
This file c ontains one or more sub sc rib er rec ords to b e mod ified . 
Eac h rec ord  inc lud es name, extension, and  switc h numb er. You 
c an edit the outp ut of the g etlist c ommand  to g enerate inp ut to this 
c ommand . If you d on’t sp ec ify an inp ut file, you must typ e eac h 
name, extension, and  switc h numb er d irec tly from your keyb oard  
after entering  this c ommand. 
> 
ofileName of the file where c ommand  statistic s will b e written.  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-32 changsw 
13
Errors 
If either the name or extension d oesn’t b elong to a valid system subsc riber, an 
error message d isp lays. If more rec ord s exist, d atab ase mod ific ation c ontinues. 
Input Format 
The Inp ut Format c onsists of one rec ord  for eac h sub sc rib er, formatted as 
follows:
Output Format
The Outp ut Format for eac h rec ord  c onsists of the c ommand  statistic s as follows:
CHANGE SWITCH ROUTINE 
(
< ADAP version name>)
name = _________; extension = _______;
new switch number = _______; 
____: CHANGED SWITCH__________
Example 
The following command modifies one subscriber in the subscriber database. 
changsw -i 
Doe, Mary, 73101, 2 
The following data appears on the screen: 
CHANGE SWITCH ROUTINE 
(
< ADAP version name>)
Doe, Mary,73101,2
name = Doe, Mary; extension = 73101; new switch number = 2;
1:  CHANGED SWITCH 2 
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX 
System 
DEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System
1 name C 29 r1v2+ D-r1.0+ I-r2.0+
2 extension K 10 r1v2+ D-r1.0+ I-r2.0+
3 new switc h numb er N 2 r1v2+ D-r1.0+ I-r2.0+
RETU RN
RETU RN
NEWLINE 
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-33 changtex 
13
changtex
Chang e sub sc rib er text-servic e mac hine and  user id entifier 
Syntax 
changtex
 -r release [-v
] [-w
] [-V
] [-i
] [< ifile] [> ofile]
Description 
This c ommand  mod ifies R1 AUDIX system sub sc rib er text-servic e mac hines and  
user id entifiers in the c urrent d atab ase of the R1 AUDIX System. Use the name, 
extension, new text-servic e mac hine, and  new user id entifier as inp ut for eac h 
sub sc rib er. Command  statistic s are written to standard  outp ut. 
-r
Release flag ; must b e followed  b y 
release. 
releaseSets d ata for the sp ec ified  release of the R1 AUDIX System (R1V4 
and  b eyond ) software.The d efault is D-r3.2.
-v
Writes transfer statistic s to the sc reen at the end  of the transfer. 
Unless -i
 is sp ec ified , p ressing  v
 while the c ommand is exec uting  
sends the upd ated  transfer status to the sc reen. 
-w
Writes a one-line summary of the exit status of this c ommand  into 
the file, main.rc
. 
-V
Writes the ADAP version number for this c ommand  and  exits without 
transferring  any sc reens d ata. 
-i
Turns off the searc h for p ossib le sub seq uent entry of the v
 and  q
 
(q uit) op tions. Otherwise, if you typ e ahead , you may lose 
c harac ters. 
If you d on’t sp ec ify -i
, you must sp ec ify an input file (
< ifile) from 
whic h the names, extensions, etc ., will b e read . 
< 
ifileName of an inp ut file you have c reated . The filename must b e 
p rec ed ed  b y the symb ol < . 
This file c ontains one or more sub sc rib er rec ords to b e mod ified . 
Eac h rec ord  c ontains name, extension, text servic e mac hine, and 
user id entifier. You c an ed it the output of the getlist
 c ommand  to 
g enerate inp ut to this c ommand. If you don’t spec ify an inp ut file, 
you must typ e eac h name, extension, text servic e mac hine, and  
user id entifier d irec tly from your keyb oard  after entering  this 
c ommand . 
> 
ofileName of the file where c ommand  statistic s will b e written.  
						

							AUDIX Administration and Data Acquisition Package  585-302-502  Issue 14
May 1999
Command Line Database Modification Commands 
13-34 changtex 
13
Errors 
If either the name or extension d oes not b elong  to a valid R1 AUDIX System 
sub sc rib er, an error message d isp lays. If more rec ords exist, d atab ase 
mod ific ation c ontinues. 
If you try to use this c ommand  with I
NTUITY or DEFINITY AUDIX Systems, an error 
messag e d isp lays on the sc reen. 
Input Format 
The Inp ut Format c onsists of one rec ord  for eac h sub sc rib er, formatted as 
follows:
Output Format
The Outp ut Format for eac h rec ord  c onsists of the c ommand  statistic s as follows:
CHANGE TEXT SERVICE MACHINE/USER ID ROUTINE 
(

)
name = _______; extension = _______; 
new text service machine = ________; new user id = ______;
____: CHANGED TEXT SERVICE MACHINE______________
/USER ID__________
FIELD       VOICE MAIL VERSIONS
Seq. 
No. Field Name TypeMax.
WidthR1
AUDIX 
System 
DEFINITY
AUDIX 
SystemI
NTUITYAUDIX 
System
1nameC29r1v4+
2extensionK10r1v4+
3new text servic e mac hineC10r1v4+
4new user idC30r1v4+