Amanda Work Group Installation Manual

							Chapter 15: Programming Amanda 219
I(
value,
operator,
value,
mailbox)
 Command that allows you to control processing based on a condition. If the speci-
fied values and operator create a condition that is true, Amanda continues process-
ing at the specified mailbox. If the condition is false, the next token after this 
command is executed.
valueAny string, number, or variable.
operatorOne of the following symbols:
>
greater than
<
less than
=
equal
!
not equal
mailboxAny valid mailbox or a variable containing a mailbox.
Examples:
I(111,,222,1000) 
continue processing at the next token.
I(%S1,=,1234,2000) 
continue at mailbox 2000 only if %S1 contains the value 1234.
I(%S1,=,IVR,2000)
continue at mailbox 2000 only if %S1contains the value IVR.
N
OTE:
When using the I() command in a Notify Method field, remember that the 
telephone port is still in Notify mode and cannot transfer a call. Therefore, 
the Extension field that you go to should start with an @. 
Failure:  
Invalid mailbox
If there is a problem with a condition, it is considered false rather than a failure
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							220 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 mailbox 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 containing 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 
message 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 example, 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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 15: Programming Amanda 221
K
						

							222 Installing [email protected]
KB(
frequency,
msecs)
 Command that plays a certain frequency for a certain time period (defined in mil-
liseconds). 
frequencyA number of Hz. For example, the only frequencies supported by the 
Rhetorex driver are those roughly within the range 300–3000 Hz. 
msecsA number of milliseconds. The range is 1–6553.
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 con-
tents 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 se-
curity 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 se-
curity 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 
						

							Chapter 15: Programming Amanda 223
KD(
msg_no
[,
mailbox] [,1
])
 Command that deletes a message from the specified or current mailbox. Using this 
command cancels any pending Notify actions for the specified message automati-
cally.
msg_noA number or a variable containing a number.
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The de-
fault is the current mailbox.
1
Optional. When used, if the specified message does not exist, Amanda 
says, Sorry, I’m unable to do that at this time.
Examples:
KD(5)deletes message 5 of the current mailbox.KD(10,212,1)deletes message 10 of mailbox 212. 
If message 10 does not exist, Amanda lets you 
know she was unable to do that and process the Done chain because the command 
failed.
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 posi-
tion. If %S0 is not found, %S2 is assigned the value 0. 
Failure:  
Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							224 Installing [email protected]
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
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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 15: Programming Amanda 225
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 mailbox. 
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 Set-
up utility.
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							226 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 val-
id 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 press-
ing # 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 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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 15: Programming Amanda 227
KT(G
n)Command for rotary training. Amanda plays the specified greeting. The greeting 
should tell the caller to press or dial 0 (zero). If the caller  presses DTMF 0,  
Amanda sets the port to detect only DTMF digits and proceeds. If the caller dials 
rotary 0, Amanda learns it and sets the port to detect only rotary digits.
This feature requires Rhetorexs Vantage VPS voice board with Rotary on Board.
G
nThe greeting  (n is replaced by 1-7) to indicate which greeting is to be 
played.
Example:
KT(G3)plays greeting 3 for rotary training.
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 
						

							228 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 
Rhetorex 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 
Rhetorex 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