Amanda Work Place Instructions Manual

							Chapter 11: Programming Amanda 103
%F(
field
[,
mailbox]) System variable that contains the value of the specified field for the specified mailbox. 
Each port has its own %F.
fieldOne of the following numbers or a variable containing that number:
1
for the Directory Name 1 field
2
for the Directory Name 2 field
3
for the Comment field
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The default is the 
current mailbox.
Example:
%F(3,126)
assigns the string from the Comment or Set Name field for mailbox 126 to %F.
Failure:  
Invalid mailbox
FLiteral that performs a hookflash. The duration of the hookflash is specified in the tele-
phone switching system dial codes section of the Setup utility. See also recall. 
Failure:  Does not fail
%G0 %G1
%G2 %G3
%G4 %G5
%G6 %G7
%G8 %G9The Amanda system has 10 global variables (%G0–%G9). Initially, each variable is 
equal to the empty string. The values of %G0–%G9 are the same no matter what port is 
current. 
If Port 1 changes %G1, then all other ports immediately see the new value for %G1. Each 
variable can contain a string of up to 143 characters.
When the system is shut down, the values of %G0–%G9 are lost. They cannot be stored 
using the [(), ](), or |() commands.
See also %S0–%S9.
Example:
+(%G0)
adds one to the current value of %G0.
=(%G2,555)
assigns the mailbox 555 to %G2.
G(%G2)
causes Amanda to go to the Extension field for mailbox 555.
Failure:  Invalid variable name (such as %G52)
G(
mailbox) Command that controls processing. Amanda continues standard processing at the spec-
ified mailbox’s Extension field (as shown in Administering [email protected]). 
mailboxA valid mailbox or a variable containing a mailbox. 
NOTE:If you use the G() command in a Notify Method field, remember that the tele-
phone port is still in Notify mode and cannot transfer a call. Therefore, the Ex-
tension field that you go to should start with an @.
Example:
G(176)
causes Amanda to go to the Extension field for mailbox 176.
Failure:  
Invalid mailbox
%HSystem variable that contains the empty string unless your 1001.PBX file (in the 
C:\PBX.DB directory) is set up for ANI or (in the future) Caller ID digits. Each port has 
its own %H.
Example:
If 1001.PBX contains:
integration 10 Cxxxxxxxccccccc
and the packet C00000007530414 arrives, %H contains the number 7530414 as long 
as the port that received the call is active.
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							104 Installing [email protected]
[
ext_no]HCommand that performs a hang-up. With an extension number, it performs an unsuper-
vised  transfer before hanging up. This H() command ends the processing of tokens for 
the current Extension or Notify Method field.
If you use an unsupervised transfer in the mailbox’s Extension field, make sure that Call 
Screening is locked off. If Call Screening is on for an supervised call, the caller is 
screened but that recording is not played to the user.
ext_noSeries of DTMF digits that indicate an extension number.
Example:
151H
causes Amanda to transfer the call to extension 151 and hang up (without waiting for a voice 
or busy signal) when Amanda is processing a call.
Failure:  
Invalid extension number
H(
mailbox) Command that performs exit routines when a caller hangs up. It specifies the mailbox to 
be processed if a hang-up condition is detected while processing the current set of to-
kens. (Processing these tokens can take Amanda to more than one mailbox.)
mailboxA valid mailbox or a variable containing a mailbox.
This command is used only in Extension fields.
Example:
H(614)
causes Amanda to go to mailbox 614 when a caller hangs up. Because you are tracking 
the number of hang ups, the Extension field for mailbox 614 has tokens that add one to 
the variable with which you are counting the hang-ups, for example, 
+(%G4).
Failure:  
Invalid mailbox
%I(
field,
msg_no
[,
mailbox]) System variable that contains the data from the specified field of the specified message. 
Each port has its own %I. This lets you extract specific information from a message. For 
example, you might use %I in  a notification record.
fieldOne of the following:
D
for the Date field
T
for the Time field
F
for the From field
msg_noThe number of an existing message. You cannot use a variable containing that num-
ber.
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The default is the 
current mailbox.
NOTE:If a message is from an outside caller, the From field of 
that message is equal to -1. If the message is from a caller who is logged on to 
Amanda, the From field contains the caller’s mailbox.
Examples:
P(%I(D,5),D)
plays the date of message 5 in the current mailbox.P(%I(T,5),T)
plays the time of message 5 in the current mailbox.P(%I(D,5,212),D)
plays the date of message 5 of mailbox 212.P(%I(F,5,212),U)
plays the Name/Extension recording of the mailbox who sent message 5 of mailbox 
212.
See the P() command for more information.
Failure:  Invalid mailbox
Invalid message number
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 105
I(
value,
operator,
value,
mailbox) Command that allows you to control processing based on a condition. If the specified 
values and operator create a condition that is true, Amanda continues processing at the 
specified mailbox. If the condition is false, the next token after this command is execut-
ed.
valueAny string, number, or variable.
operatorOne of the following symbols:
>greater than

						

							106 Installing [email protected]
J(
file_or_box,
phone_no
[,
tokens]) Command that allows a fax to be received as a file (for later transmission with the T() 
command) or as a message for a mailbox.
Before using this command, make sure the configuration settings for the physical serial 
port have been defined. 
file_or_boxA string or variable indicating where the fax is to be stored. It contains either a mail-
box indicating whose message it is or a valid DOS file name for a text file. Use the 
complete path to the file unless the file is in C:\AMANDA.
phone_noThe telephone number for the fax device that sends the transmission or a variable con-
taining that number. 
Use the empty string to make Amanda wait until a call rings into the appropriate fax 
port. (When not in a variable, the empty string must appear in this command as a pair 
of double quotation marks—even though some commands allow you to omit them.) 
tokensOptional. A string or variable that defines the actions Amanda takes to connect the 
call to the fax port. 
This command is used only in Extension fields.
Example:
J(123,,P(G1)%X%F-H) 
sets up a personal fax mail mailbox. In this case, mailbox 123 receives a fax as a mes-
sage and P(G1) plays a greeting such as “Start your fax machine at the tone.” 
The following tokens allow for one-call fax transmission:
%X The system variable that contains the codes needed to get the transfer dial tone on the 
current port
%F The extension of the fax port being used
-H A hang-up (after pausing a half second to complete an unsupervised transfer) 
J
(C:\\FAXES\\FAX1,)
makes Amanda set up one of her fax modems to wait for a call and accept a fax called 
C:\FAXES\FAX1. You can use this to fax files to your own Amanda system. For exam-
ple, if you print a text file that contains information for customers and then fax it to 
Amanda, Amanda can fax that information out to customers using the T() command.
Failure:  Invalid mailbox
Fax modem not configured properly
Physical port not available
Logical port not configured properly
K
						

							Chapter 11: Programming Amanda 107
KA(
on_off)
 Command that dials the PBX parameter dl_light_on or dl_light_off specified in the telephone sys-
tem dial codes. 
on_off1 or 0 to indicate whether the message waiting indicator is turned on or off.
When the value is1, the message waiting indicator is turned on as Amanda dials the 
codes for “What to dial to set the message waiting indicator on” (the dl_light_on pa-
rameter).
When the value is0, the message waiting indicator is turned off as Amanda dials the 
codes for “What to dial to set the message waiting indicator off” (the dl_light_off pa-
rameter).
Most of the popular telephone systems have specified values that turn the message waiting indica-
tor on and off. If these values are not pre-defined for your system, you can set them using Aman-
da’s Setup utility.
Example:KA(1)
causes Amanda to dial the string specified in the dial codes for What to dial to set the 
message waiting indictor on.
Failure:  Does not fail
KB(
frequency,
msecs) Command that plays a certain frequency for a certain time period (defined in millisec-
onds). 
frequencyA number of Hz. 
msecsA number of milliseconds. 
Example:KB(350,2000)
plays the frequency 350 Hz for two seconds. 
Failure:  Does not fail
KC(
mailbox,
variable) Command that compares the security code for the specified mailbox with the contents of 
a variable. If there is a match, the command is successful. For callers who do not know 
the security code, Amanda continues processing using the mailbox in the Done Chain 
field.
mailboxAny valid mailbox or a variable containing a mailbox. 
variableThe port or global variable whose contents are matched against the security code of 
mailbox. 
Example:R(G1,%S1)KC(212,%S1)KL(%S1)
assigns the DTMF digits entered by the caller to %S1, compares %S1 with the security 
access code of mailbox 212, and takes the appropriate action.
After the caller passes the security check, the KL() command allows the caller to log on 
to the mailbox. See also the KL() command.
Failure:  Invalid mailbox
Invalid security code
Security codes do not match
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							108 Installing [email protected]
KD(
msg_no
[,
mailbox]) Command that deletes a message from the specified or current mailbox. Using this com-
mand cancels any pending Notify actions for the specified message automatically.
msg_noA number or a variable containing a number.
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The default is the cur-
rent mailbox.
Examples:KD(5)
deletes message 5 of the current mailbox.KD(10,212)
deletes message 10 of mailbox 212. 
Failure:  Invalid mailbox
Invalid message number
KI(
target, 
source,
variable) Command that searches one string (called the source string) to see if it contains a copy 
of another string (called the target string).
targetA string or a variable containing the string to be searched for inside the source. 
sourceA string or a variable containing the string to search. 
variableThe port or global variable to which the KI() command assigns one of the following:
 Zero if the target is not found in the source.
 The number of the position within the source string at which the copy of the target 
string starts.
Examples:KI(UL,PAUL INCE,%S1)
is a successful search and assigns the value 3 to %S1KI(ULL,PAUL INCE,%S1)
fails and assigns the value 0 to %S1KI(%S0,%S1,%S2)
means if a copy of %S0 is found within %S1, %S2 is assigned its character position. If 
%S0 is not found, %S2 is assigned the value 0. 
Failure:  Does not fail
KJ(
mailbox,
list_number
[,
sender])Allows a caller to record a message that, when saved, is sent to a list of users.
mailboxAny valid mailbox or a variable containing a mailbox.
list_numberAny valid list number (1–8 or 10–30). If the mailbox number is 999, then the list 
number is for a system list rather than a user list.
senderOptional. Provides a sender for the message or treats the message as though it were 
from outside the Amanda system.
When 0, the message is treated as a message from outside the Amanda system. 
Amanda does not identify the sender. This is the default.
When 1, the Message From field contains the number of the mailbox containing this 
token. Amanda plays the name and extension recording for that mailbox’s owner 
when identifying the sender.
Example:
KJ(128,5)
causes Amanda to record a message and then send it to the users on mailing list 5 for 
mailbox 128. 
Failure:  Invalid mailbox or list number or out of disk space
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 109
KL(
mailbox,
security_code)
 Command that logs the current caller on to the specified mailbox. The caller is at the top level 
menu (the menu that says “Press 1 to play your messages....”). 
mailboxAny valid mailbox or a variable containing a mailbox.
security_codeThe security code for the specified mailbox.
Example:
R(G1,%S1)R(G2,%S2)P(G5)P(%S1,N)KL(%S1,%S2)
Greeting 1 says, “Please enter the mailbox you wish to log into.” After the caller enters the 
mailbox, Amanda assigns it to %S1. Greeting 2 says, “Please enter the mailbox’s security code.” 
After the caller enters the code, Amanda assigns it to %S2. Next Amanda plays Greeting 5, “You 
are logging into mailbox”, followed by the mailbox. KL(%S1,%S2) attempts to log the caller into 
the specified mailbox  using the specified security code.
Failure:  
Invalid mailbox
Invalid security code
ext_noKMCommand that tells Amanda to do a supervised transfer to the specified extension, create 
a conference call for the caller and the user at the extension (using the dl_conference 
configuration setting), and record the call until detecting a hang-up or #. Amanda then 
makes the recording a message for the user.
ext_noSeries of DTMF digits that indicate an extension number.
Example:
128KM
causes Amanda to transfer the call (if she is processing a call) to extension 128, starts a 
conference call, and records the conference call as a message for mailbox 128. 
Failure:  Invalid extension number
KP(
mailbox,
security_code) Command that sets the security code for the specified mailbox.
mailboxAny valid mailbox or a variable containing a mailbox. 
security_codeString of DTMF digits that indicate the new security code for the specified mail-
box. 
Example:
KP(128,”5404”)
causes Amanda to change the security code for mailbox 128 to 5404.
Failure:  Invalid mailbox
mailbox is locked or read-only
Security code is an empty string, contains invalid characters, or exceeds limit set by the 
configuration option security_min_length. You set this option using the Setup utility.
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							110 Installing [email protected]
KR(
file_or_box
[,
recording_info])
 Command that makes a recording and stores it as either a file or a message for the specified 
mailbox.
file_or_boxA string or variable indicating where the recording is to be stored. It contains 
either a mailbox indicating whose message it is or a valid DOS file name. Use the 
complete path to the file unless the file is in C:\AMANDA. 
recording_infoA number from 0 to 3 indicating whether the caller hears a beep (to start 
recording) and the post record menu. The default is 1.
0 No beep; no post record menu.
1 Beep; no post record menu.
2 Beep; post record menu.
3 No beep; post record menu.
Examples:
KR(212)makes the recorded response a new message for mailbox 212.KR(C:\\MSG.VOX)stores the response in the MSG.VOX file in the root directory. In both cases, the caller hears the 
beep for recording but no post record menu.
N
OTE:
When using the KR() command, be sure to ask the caller to leave a message. A 
suggested example is:
P(G1)KR(212)Greeting 1 says, “Please leave a message at the tone. Finish by pressing # or hanging 
up.”
Failure:  
Invalid mailbox
Unable to create file
KS
[(
errorlevel)
] Command that starts a system shutdown immediately. 
errorlevelOptional. Specifies the exit code (a DOS errorlevel) at which the system 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 errorlevel 
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 ex-
ceed 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 contents of the spec-
ified 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 carriage 
return/linefeed separated records or .DBF file)
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 111
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 individ-
ual mailboxes might need to be recorded by the users in the new language.
fileA string or variable containing the name of a valid Amanda system language 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 Rhetorex 
voice board) or ENGLISH.BDX (if your system is connected to a Norstar KSU) in the 
C:\AMANDA directory.
L(SPANISH)
changes the prompts to those found in SPANISH.IDX (if your system has a Rhetorex 
voice board) or SPANISH.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 when-
ever you use LEN. Be careful not to confuse them with the non-bold brackets that indi-
cate 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() command for more 
information.
Failure:  Does not fail
%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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							112 Installing [email protected]
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 completed.
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 token. 
If the caller makes an invalid selection, Amanda restarts the M() command. 
If the caller makes a valid selection (for example 5), Amanda immediately continues 
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 ex-
ecutes the next token in the Extension field. 
Failure:  Invalid mailbox
%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, 
varable})Command that searches the specified file for all the records that match the specified val-
ue. 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 ex-
ceed 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 contents of the spec-
ified 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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription