Amanda Work Group Manual

							Chapter 10: Programming Amanda 141
=(
variable,
value
[,
start,
end]) Command that gives the specified variable the specified value. Use start and end to 
assign only part of the string (a substring) to the variable.
variableOne of the port or global variables.
valueA string, number, or variable.
startOptional. The starting character position to copy from value. The default is to copy 
the entire string. If start is less than 0, it is ignored.
endOptional, but must be used if start is used. The last character position to copy from 
value. If end is greater than the length of the string, the last character position of the 
string is used.
Examples:
=(%S1,FRENCH)
Gives %S1 the value of FRENCH=(%S1,FRENCH,3,4)
Gives %S1 the value of EN. 
If %S2 is the telephone number 7530414,
=(%S1,%S2,1,3)
extracts the prefix 753 from %S2 and assigns it to %S1
If %S3 is 1 and S4 is 1, 
=(%S1,MARY,%S3,%S4)
 %S1 is assigned M. 
Failure: Start greater than the length of the string
>(
file) Before using this command, you start incremental faxing with the () command more than once (per incremental fax), it is 
faxed only once.
fileA string or variable containing a valid DOS file name for the text file to be 
transmitted. Use the complete path to the file unless the file is in C:\AMANDA.
This command is used only in Extension fields.
Example:
See the 
						

							142 Installing [email protected]/Windows
%DSystem variable that contains the percentage of free disk space. 
Example:
I(%D,
						

							Chapter 10: Programming Amanda 143
%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 
specified mailbox’s Extension field. 
mailboxA valid mailbox or a variable containing a mailbox. 
NOTE: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. Therefore, 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 
unsupervised  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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							144 Installing [email protected]/Windows
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 tokens. 
(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 
number.
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 10: Programming Amanda 145
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 
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.
NOTE:
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 
						

							146 Installing [email protected]/Windows
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. See “Serial Port Settings” on page 221.
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
K
						

							Chapter 10: Programming Amanda 147
KA(
on_off)
 Command that dials the PBX parameter dl_light_on or dl_light_off specified in the telephone 
system dial codes.  This command is often used in notification templates.
on_off1 or 0 to indicate whether the message waiting indicator is turned on or off. You can 
use a variable that contains a 1 or 0.
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 
parameter).
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 
parameter).
Most of the popular telephone systems have specified values that turn the message waiting 
indicator on and off. If these values are not pre-defined for your system, you can set them using 
Amanda’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 
milliseconds). 
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. 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 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)assigns the DTMF digits entered by the caller to %S1, compares %S1 with the security access code 
of mailbox 212. Additional tokens would take some appropriate action.
Failure:  
Invalid mailbox
Invalid security code
Security codes do not match
KD(
msg_no
[,
mailbox]) Command that deletes a message from the specified or current mailbox. Using this 
command 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 current 
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
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							148 Installing [email protected]/Windows
KG(
address,
subject,
msg_no
[,
msg_disp
[,
mailbox
[,
sound_type]]])Forwards voice and fax messages—or a notification about those messages—to an Internet e-mail 
address. All the components of each message being forwarded are included in the resulting e-mail, 
which is in MIME format. Voice components are converted to WAV files containing GSM audio 
(for maximum compression while still being playable on all Windows 9x, NT, and 2000 systems). 
Fax components are converted to TIFF/F format.
The user will be using one of the following:
 Only the Amanda mailbox to process voice and fax messages. In this case, this token is 
used to notify the user that messages await processing in the Amanda mailbox. This 
token uses the combination of msg_no 0 and msg_disp 0.
 Only the Internet address (and not the Amanda mailbox) to process voice and fax 
messages. In this case all messages stored by the Amanda system are forwarded and then 
deleted. This token uses the combination of msg_no -1 and msg_disp 2.
 Both the Internet address and the Amanda mailbox to process voice and fax messages. 
In this case only new messages stored by the Amanda system are forwarded to the 
Internet address when necessary. Those that are forwarded are then marked as read and 
non-urgent. This token uses the combination of msg_no -1 and msg_disp 1.
addressA string or a variable containing the Internet e-mail address to which the message will 
be sent. 
subjectA string or a variable containing the default subject to be used when a message has no 
subject or when no message is being forwarded to the Internet e-mail address. For 
example, you might use New Voice Message with a message or Check Voice Mail 
when no message is sent. If a forwarded message has a subject, that subject is used 
instead of the default subject.
msg_noIndicates what messages are to be forwarded. Use one of the following values as a 
number or in a variable:
 The message number of just one voice or fax message to be forwarded to the Internet 
e-mail address.
 0 to indicate that no message is being forwarded. When you use 0, a new message, 
consisting of only the default subject, is created and sent. The new message serves 
as a notification about existing voice or fax messages.
 -1 to forward all messages (when msg_disp is set to 2) or all new messages (when 
msg_disp is set to 1). Do not
 use -1 when msg_disp is set to 0. 
msg_dispOptional. Indicates what to do with voice and fax messages that have been sent 
successfully. This parameter is ignored when msg_no is 0. The default is 0. Use one 
of the following values:
 0 to leave the forwarded messages as they are in the Amanda mailbox.
 1 to make sure that the new messages in the Amanda mailbox are no longer marked 
new or urgent.
 2 to delete all the messages in the Amanda mailbox.
mailboxOptional. Any valid mailbox or a variable containing a mailbox. Indicates what 
mailbox on the Amanda server contains the messages to be sent. The default is the 
current mailbox. If you wish to use the sound_type parameter, you must set this to a 
value. You can use %U for the current mailbox number.
sound_typeA string or a variable containing one of the following sound types. Which type works 
best depends on the recipient’s e-mail client and .wav file player. These settings are 
not case-sensitive. The default is X-MS-WMA. You may need to experiment to find 
the best setting.
 X-MS-WMA requests that the receiving client use Windows Media Player for voice 
messages.
 X-WAV works with Sound Recorder.
 WAV is more generic.
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 10: Programming Amanda 149
KG cont.Examples:KG(%V,CHECK VOICE MAIL,0)
causes Amanda to sent an Internet e-mail notification to the e-mail address specified in 
%V.
KG(%V,NEW VOICE MAIL,-1,1)
causes Amanda to send all new messages in the current mailbox to the e-mail address 
specified in %V. After sending the messages successfully, Amanda makes sure that the 
messages are no longer marked new or urgent.
KG(%V,NEW VOICE MAIL,-1,2,%U,X-WAV)
causes Amanda to send all the messages in the current mailbox to the e-mail address 
specified in %V. Amanda specifies that the voice messages have the sound type X-
WAV, expecting the Sound Recorder to play them on the computer that receives them. 
After sending the messages successfully, Amanda deletes all the messages.
Note: If you use %V as in these examples, you must specify Internet e-mail addresses in 
the Variable field of users’ message notification templates.
Failure:  Invalid mailbox number
Invalid message number
Use of msg_no -1 with msg_disp of 0
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 
						

							150 Installing [email protected]/Windows
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 the system 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 Setup utility.
KQ(
phone_no
[,
mailbox])Command that searches the messages in the current or specified mailbox and locates up to 20 fax 
messages. Each fax message is marked heard and the faxes are queued to be sent to the specified 
telephone number as one fax message.
phone_noThe telephone number (or a variable containing that number) for the fax device that 
accepts the transmission. Use the empty string to make Amanda wait for a call to ring 
into the fax port.
mailboxOptional. Any valid mailbox or a variable containing a mailbox. The default is the 
current mailbox.
Example:
KQ(7145555555,126)
causes Amanda to search mailbox 126 for fax messages and send them to 714-555-5555.
Failure:  Invalid mailbox
no fax messages for the specified or current mailbox
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription