Amanda Work Group 7xx Installation Manual

							Chapter 11: Programming Amanda 189
G(
mailbox)
 Command that controls processing. Amanda continues standard processing at the 
specified mailbox’s Extension field (as shown in Administering Aman-
[email protected]/DOS). 
mailboxA valid mailbox or a variable containing a mailbox. 
N
OTE:
If you use the G() command in a Notify Method field, remember that the 
telephone port is still in Notify mode and cannot transfer a call. There-
fore, the Extension 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.
[ext_no
]HCommand that performs a hang-up. With an extension number, it performs an un-
supervised  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 wait-
ing for a voice or busy signal) when Amanda is processing a call.
Failure:  
Invalid extension number
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							190 Installing [email protected]
H(
mailbox)
 Command that performs exit routines when a caller hangs up. It specifies the mail-
box to be processed if a hang-up condition is detected while processing the current 
set of tokens. (Processing these tokens can take Amanda to more than one mail-
box.)
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 mes-
sage. 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 con-
taining that number.
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The 
default is the current mailbox.
N
OTE:
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 191
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 
						

							192 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 11: Programming Amanda 193
K*(
ext,
on_off)
 Only for Amanda systems using the tAA voice board for Norstar. Turns the mes-
sage waiting indicator for the specified extension on or off.
extThe extension to turn on or off. 
on_offUse one of the following:
1
Turns the light on.
0
Turns the light off.
Examples:
@
K*(%E,1)
used in a notification record to turn the message waiting indicator on.@K*(%E,0)used in a notification record to turn the message waiting indicator off.
Failure:  
Does not fail
K
						

							194 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 
Brooktrout driver are those roughly within the range 300–3000 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 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 11: Programming Amanda 195
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
KF(
feature)
 Command that sends a sequence of Norstar feature codes to the Norstar KSU. 
Amanda sends the sequence without checking for any errors (such as an invalid fea-
ture code or extension number).
featureSequence of numbers indicating Norstar feature codes and extension 
numbers.
Examples:
KF(423)forwards a call to extension 23. The feature code for call forwarding is 4. The ex-
tension that receives the call, in this example, is extension 23.
Failure:  
Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							196 Installing [email protected]
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
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 197
KL(
mailbox)
 Command that logs the current caller on to the specified mailbox, bypassing the 
mailbox’s security code unless the KC() command is also used. The caller is at the 
top level menu (the menu that says “Press 1 to play your messages....”). This com-
mand is usually used right after the KC() command.
mailboxAny valid mailbox or a variable containing a mailbox.
Example:
R(G1,%S1)P(G5)P(%S1,N)KL(%S1)is a simplified example that doesn’t use the KC() command.
 
Greeting 1 says, “Please enter the mailbox you wish to log into.” After the caller 
enters the mailbox, Amanda assigns it to %S1. Next Amanda plays Greeting 5, 
“You are logging into mailbox”, followed by the mailbox. KL(%S1) logs the caller 
into the mailbox. Because no security code is required, using the KL() command 
without the KC() command can introduce security risks into the system. See also 
the KC() command.
Failure:  
Invalid mailbox
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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

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