Amanda Work Group 7xx Installation Manual

							Chapter 11: Programming Amanda 199
KS
[(
errorlevel)
]
 Command that starts a system shutdown immediately. 
errorlevelOptional. Specifies the exit code (a DOS errorlevel) at which the sys-
tem exits. The default exit code (errorlevel) is zero. 
This command is used only in Extension fields.
Example:
KS(3)immediately shuts down the system, exiting with the errorlevel set to 3. The error-
level can be used by another program or a DOS batch file to determine what action 
should be taken next. 
Failure:  
Does not fail
KV(
file,
field,
value)
 Command that finds and deletes the first record in the specified file that has the 
specified value in the specified field.
fileA string or variable containing a valid DOS file name for the text or DBF 
file. Use the complete path to the file unless the file is in C:\AMANDA. 
No line in the file should exceed 143 characters. There is no limit to the 
number of lines in the file.
fieldA number, string, or variable that indicates the number or name of a field. 
valueA string or variable that contains the data to be compared with the con-
tents of the specified field. 
Example:
KV(C:\\LISTS\\PHONE.LST,4,STEVE BRUCE)searches for the first record in the PHONE.LST file that contains the value STEVE 
BRUCE in field 4. If found, the entire record is deleted. If not found, no record is 
deleted (but the command is still successful). 
Failure:  
The file is read-only
Insufficient disk space to save file
File is not the correct format (text file containing comma-separated fields and car-
riage return/linefeed separated records or .DBF file)
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							200 Installing [email protected]
L(
file)
 Command that immediately changes the system prompts to use the specified 
Amanda system language file. This changes the system prompts, but the greetings 
of the individual mailboxes might need to be recorded by the users in the new lan-
guage.
fileA string or variable containing the name of a valid Amanda system lan-
guage file (minus the .IDX extension and the DOS path). Amanda knows 
that the system language file names end in .IDX and are located in the 
Amanda directory.
Examples:
L(ENGLISH)
changes the prompts to those found in 
ENGLISH.IDX (if your system has a 
Brooktrout voice board) or ENGLISH.BDX (if your system is connected 
to a Norstar KSU)
 in the C:\AMANDA directory.
L(MEXICAN)
changes the prompts to those found in 
MEXICAN.IDX (if your system has a 
Brooktrout voice board) or MEXICAN.BDX (if your system is connected 
to a Norstar KSU)
 in the C:\AMANDA directory. 
Failure:  
Does not fail (If you specify a file that doesn’t exist or is not a prompt 
file, Amanda uses the current prompt file.)
LEN[
string]
 Assumes the value of the total number of characters within a string or digits within 
a number.
stringAny string, number, or variable.
N
OTE:
The brackets in this syntax are bold. The brackets are a required part of 
the syntax whenever you use LEN. Be careful not to confuse them with 
the non-bold brackets that indicate that the syntax within the brackets is 
optional.
Example:
LEN[7145551212]
assumes the value 10.
I(LEN[%S1],=,4,%S1)
checks the length of the DTMF entry stored in %S1 because all extensions have 4 
digits. If %S1 contains a mailbox, Amanda goes to that mailbox. See the I() com-
mand for more information.
Failure:  
Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 201
%M
[(
mailbox)
]
 Command that returns the total number of messages for the specified or current 
mailbox. Each port has its own %M.
mailboxOptional. A valid mailbox or a variable containing a mailbox. The default 
is the current mailbox. 
Example:
%M(321)
contains the number of messages stored for mailbox 321.
Failure:  
Invalid mailbox
M(
greeting
[#mailbox
],
repetition,
delay)
 When Amanda processes this command, she plays the specified greeting and waits 
for a single DTMF digit to be pressed by the caller. Amanda immediately finds the 
matching menu selection and continues processing at the specified mailbox. This 
eliminates the normal delay for determining that a DTMF entry has been complet-
ed.
greetingOne of the seven mailbox greetings (G1–G7). This greeting should be 
a menu from which the caller is to make a selection. 
mailboxOptional. Any valid mailbox. The default is the current mailbox. 
repetitionThe number of times to play the greeting. 
delayThe amount of time (in tenths of seconds) to wait before repeating the 
greeting. 
This command is used only in Extension fields.
Examples:
M(G1,2,20)Amanda plays Greeting 1 twice, pausing for two seconds before repeating it. If the 
caller presses a DTMF digit, Amanda stops the greeting and uses the caller’s digit 
to process the menu.
If the caller makes no selection at all, Amanda continues processing at the next to-
ken. 
If the caller makes an invalid selection, Amanda restarts the M() command. 
If the caller makes a valid selection (for example 5), Amanda immediately contin-
ues processing at the mailbox specified in the Menu field 5.
M(G1#111,2,30)plays Greeting 1 from mailbox 111. If there is no response from the caller, Amanda 
plays Greeting 1 again after a 3 second pause. If there is still no response, Amanda 
executes the next token in the Extension field. 
Failure:  
Invalid mailbox
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							202 Installing [email protected]
%NSystem variable that contains the number of new messages for the current mailbox. 
Each port has its own %N.
Example:
P(%N,N)
causes Amanda to say the number of new messages as a number.
N(
file,
field,
value
{,
field,
variable
})Command that searches the specified file for all the records that match the specified 
value. This command changes the values in up to 8 fields in each matching record 
using the values stored in the specified variables. If no matching records are found, 
Amanda continues processing the next token. See also the V() command.
fileA string or variable containing a valid DOS file name for the text or DBF 
file. Use the complete path to the file unless the file is in C:\AMANDA. 
No line in the file should exceed 143 characters. There is no limit to the 
number of lines in the file.
fieldA number, string, or variable that indicates the number or name of a field. 
The first field indicates what field to compare with value; the additional 
(up to 8) fields indicate what fields to change. Each field is changed to the 
value of its corresponding variable. (.DBF files have field names; text 
files have field numbers.)
valueA string or variable that contains the data to be compared with the con-
tents of the specified field. 
variableOne of port or global variables. 
Example:
N(C:\\LISTS\\PHONE.LST,1,RYAN GIGGS,3,%S1,2,%S2)finds all records in the file PHONE.LST that have RYAN GIGGS in the first 
field and replace the contents of field 2 with the value of %S2 and the contents of 
field 3 with the value of %S1. Numbers are used for the fields because 
PHONE.LST is a text file. 
Failure: 
Specified file does not exist
Value of field not found within the file
O(
time)
 Command that makes Amanda go on-hook for the specified amount of time. De-
pending upon the value used, you can cause a hookflash or a hang-up. This is par-
ticularly useful for generating an intermediate hang-up condition during token 
processing without terminating the actual continued token processing. See also the 
H() command.
timeA number in tenths of seconds or a variable containing that number.
Example:
O(20)
causes Amanda to go on-hook for two seconds.
Failure:  
Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 203
%PSystem variable that contains the previous mailbox, that is, the last mailbox access-
ed before the current mailbox. Each port has its own %P. See also %U (current 
mailbox).
Example:
While accessing mailbox 990, %U is 990. Then a caller enters 222 and is trans-
ferred to that extension. As mailbox 222 is accessed, %U becomes 222, and %P be-
comes 990.
P[repetition]
(date,D
[,hangup]) Command that tells Amanda to say the specified number as a date. 
repetitionThe number of times to repeat the date. The default is 1. 
dateA number in either of the following formats: MMDDYY (which 
assumes the year 19YY,) or MMDDYYYY. For dates after 1999, you 
must use MMDDYYYY. 
Despite this format, the date is read in the order that most speakers of 
the prompt language (specified using the Setup utility) expect to hear 
it. If the year is the current year, Amanda does not read the year. 
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(06261994,D)
causes Amanda to say June twenty-sixth, nineteen ninety-four 
Failure:  Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							204 Installing [email protected]
P[repetition]
(amount,
currency
[,hangup]) Command that tells Amanda to say the specified number as an amount of 
money.
repetitionThe number of times to repeat amount. The default is 1. 
amountA number from 0 to 999 million. 
currencyUse one of the following:
$For dollars and cents.
FFor francs and centimes.
PFor pesos and centavos.
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(06261994,$)
cause Amanda to say Sixty-two thousand six hundred nineteen dollars 
and ninety-four cents 
The monetary terms are always available, regardless of the system 
language. 
P[repetition]
(number,N
[,hangup]) Command that tells Amanda to say the absolute value of the number. 
repetitionThe number of times to repeat absolute value. The default is 1. 
numberA number or variable representing a number from 0 to 999 million. 
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
N
OTE:
Use a condition to test whether the number is positive or negative. Use 
a greeting that says “negative” or “minus” to handle negative 
numbers.
Examples:
Suppose that %S1 contains -1234 and G1 contains the recording 
“negative,” then
I(%S1,>,0,1001)P(G1)P(%S1,N)
causes Amanda to say “negative one thousand two hundred thirty-four”. 
(mailbox 1001’s Extension field would not include the greeting—just the 
command, 
P(%S1,N))
P(06261994,N)
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 205
P[repetition]
(time,T
[,hangup]) Command that tells Amanda to say the specified number as a time of day.
repetitionThe number of times to repeat the contents of the port variable. The 
default is 1. 
timeA number or variable containing a number that specifies a time in the 
24-hour HHMM format. However, Amanda says the time in a 12-hour 
format, followed by 
A.M. or P.M.
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(1826,T)
causes Amanda to say “Six, twenty-six P.M.”
Failure:  Does not fail
P[repetition]
(A,string
[,hangup]) Command that tells Amanda to say the characters in the specified string. 
For a space, Amanda says the word “space”.
repetitionThe number of times to repeat the contents of the string. The default 
is 1. 
stringA string of letters from the alphabet and spaces. 
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(A,GEORGE BEST)
causes Amanda to say “G,” “E,” “O,” “R,” “G,” “E,” “space,” “B,” “E,” 
“S,” “T.”
Failure:  Does not fail
P[repetition](D)
 Command that tells Amanda to say the percentage of remaining disk space.
repetitionThe number of times to repeat the percentage of disk space. The 
default is 1. 
Examples:
P(D)
causes Amanda to say “The percentage of free disk space is” followed by 
the percentage as a number, e.g., forty-two.
Failure:  Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							206 Installing [email protected]
P[repetition]
(greeting
[,mailbox
[,hangup]]) Command that tells Amanda to play the specified greeting for the specified 
or current mailbox.
repetitionThe number of times to repeat the greeting. The default is 1. 
greetingOne of the seven mailbox greetings (G1–G7). 
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The 
default is the current mailbox. 
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(G1)
causes Amanda to play Greeting 1 for the current mailbox.
Failure:  Invalid mailbox
P[repetition]
(M[,mailbox
[,hangup]]) Command that tells Amanda to say the total number of messages for the 
specified or current mailbox.
Using this command cancels any pending Notify actions for the specified 
message automatically. 
When this command plays a message that is marked with Receipt 
Verification, the verification message’s From field contains the mailbox 
which executed this command.
repetitionThe number of times to repeat the number of messages. The default is 
1. 
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The 
default is the current mailbox. 
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(M,212)
causes Amanda to say the total number of messages for mailbox 212.
Failure:  Invalid mailbox
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 207
P[repetition]
(Mn[,mailbox
[,hangup]]) Command that tells Amanda to play the message with the specified 
number for the specified or current mailbox.
repetitionThe number of times to repeat the message. The default is 1. 
nThe number of the message to be played. 
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The 
default is the current mailbox. 
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P3(M1,212)
causes Amanda to play message 1 for mailbox 212 three times.
Failure:  Invalid mailbox
P[repetition]
(MN[,mailbox
[,hangup]])Command that tells Amanda to play all new messages for the specified or 
current mailbox. 
repetitionThe number of times to repeat the message. The default is 1. 
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The 
default is the current mailbox.
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(MN)
causes Amanda to play the new messages for the current mailbox. 
Failure:  Invalid mailbox
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							208 Installing [email protected]
P[repetition]
(N[,mailbox
[,hangup]]) Command that tells Amanda to play the Name/Extension recording of the 
specified or current mailbox. If there is no recording, nothing is played. 
See also 
P[repetition](U[,mailbox]).
repetitionThe number of times to repeat the Name/Extension recording. The 
default is 1. 
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The 
default is the current mailbox. 
hangupOptional. The number 1 or 0 indicating how to process a hangup. The 
1 means that the processing of this token ends. 0 means that the 
processing of this token ends, the string of tokens is aborted, and the 
channel hangs up so that it can wait for a new call.
Example:P(N)
causes Amanda to play the Name/Extension recording for the current 
mailbox.
Failure:  Invalid mailbox
P[repetition]
(DTMF) Command that tells Amanda to say a number as DTMF digits. This is 
usually used for repeating the number corresponding to the DTMF tones 
entered by a caller.
repetitionThe number of times to repeat the DTMF digits. The default is 1. 
DTMFA number or variable containing a series of DTMF digits. 
Example:P(%S5)
causes Amanda to say the DTMF digits in %S5. For example, if %S5 
contains the number 411, Amanda says 4–1–1 instead of four hundred 
eleven.
Failure:  Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription