Amanda Work Group Manual

							Chapter 10: Programming Amanda 131
Free disk spaceP[
repetition] (D) 
%D
FrequencyKB(
frequency,
msecs) 
From%I(
field,
msg_no[,
mailbox])
GotoG(
mailbox) 
GreetingP[
repetition](
greeting[,
mailbox[,
hangup]]) 
Hang-up[
ext_no]H
O(
time) 
Hang-up, cleanupH(
mailbox) 
Hang-up, partially supervisedU-
ext_no
HookflashE
F
O(
time) 
IfI(
value,
operator,
value,
mailbox) 
Import, file{
file}
Information mailboxesM(
greeting[#
mailbox],
repetition,
delay) 
IVR%I(
field,
msg_no [,
mailbox]) 
Languages, changeL(
file) 
LengthLEN[
string] 
Letters and spacesP[
repetition](A,
string[,
hangup]) 
LIGHT.ON
See also message waiting indicators.X[(
file)] 
Y[(
file)] 
Z[(
file)] 
MenuM(
greeting[#
mailbox],
repetition,
delay) 
Messages%I(
field,
msg_no[,
mailbox])
Messages, deleteKD(
msg_no[,
mailbox]) 
Messages, forwarding to Internet e-mail 
addressKG(
address,
subject,
msg_no[,
msg_disp[,
mailbox
[,
sound_type]]])
Messages, from recordingsKR(
file_or_box[,
recording_info])
Messages, notifying Internet e-mail 
address about voice and fax messagesKG(
address,
subject,
msg_no)
Quick Token Reference (Continued)
Function/Purpose of TokenSyntax 
						

							132 Installing [email protected]/Windows
Messages, number%M[(
mailbox)] 
Messages, number of new%N
Messages, playing by numberP[
repetition](M
n[,
mailbox[,
hangup]]) 
Messages, playing new messagesP[
repetition](MN[,
mailbox[,
hangup]]) 
Messages, record and send to mailing listKJ(
mailbox,
list_number[,
sender])
Messages, totalP[
repetition](M[,
mailbox[,
hangup]]) 
Message count, total for mailbox%M[(
mailbox)]
P[
repetition] (M[,
mailbox[,
hangup]])
Message count, new for current user%N
Message waiting indicators, creatingX[(
file)] 
Message waiting indicators, deletingY[(
file)] 
Message waiting indicators, testing forZ[(
file)]
Message waiting indicators, turning on 
and offKA(
on_off)
MoneyP[
repetition](
amount,
currency[,
hangup]) 
Name and extensionP[
repetition](U[,
mailbox[,
hangup]]) 
P[
repetition](N[,
mailbox[,
hangup]]) 
Notification record, Method field@
Notification record, Variable fieldP[
repetition] (V)
%V
Notify Internet e-mail address about voice 
and fax messagesKG(
address,
subject,
msg_no)
Notify, relay pagingP[
repetition] (R)
%R
NumberP[
repetition] (
number,N[,
hangup]) 
P[
repetition] (V) 
On-hookO(
time) 
PagerP[
repetition] (R) 
%R
%V
Quick Token Reference (Continued)
Function/Purpose of TokenSyntax 
						

							Chapter 10: Programming Amanda 133
Pager, wait forW(
n,P[,
mailbox]) 
KW[(
rings[,P|V])]
Partial supervised transferU-
ext_no
Pauses-
, 
W(n)
PesosP[
repetition](
amount,P[,
hangup]) 
Playing, absolute valueP[
repetition](
number,N[,
hangup])
Playing, currencyP[
repetition](
amount,
currency[,
hangup]) 
Playing, dateP[
repetition](
date,D[,
hangup]) 
Playing, disk spaceP[
repetition](D) 
Playing, DTMF digitsP[
repetition](R) 
P[
repetition](
DTMF) 
Playing, greetingP[
repetition](
greeting[,
mailbox[,
hangup]]) 
Playing, menuM(
greeting[#
mailbox],
repetition,
delay) 
Playing, messagesP[
repetition](M
n[,
mailbox[,
hangup]]) 
P[
repetition](MN[,
mailbox[,
hangup]]) 
Playing, moneyP[
repetition](
amount,
currency[,
hangup]) 
Playing, name and extensionP[
repetition](N[,
mailbox[,
hangup]]) 
P[
repetition](U[,
mailbox[,
hangup]]) 
Playing, numberP[
repetition](
number,N[,
hangup]) 
Playing, number of messagesP[
repetition](M[,
mailbox[,
hangup]]) 
Playing, promptP[
repetition](
prompt_no,V[,
hangup]) 
Playing, spellingP[
repetition](A,
string[,
hangup]) 
Playing, timeP[
repetition](
time,T[,
hangup]) 
Playing, Variable fieldP[
repetition](V) 
Playing, voice fileP[
repetition](X,
file[,
hangup]) 
PortsS(
port,[
string,[
variable],[
termination],
[
length],[
timeout]) 
Ports, change volume^(
volume_change) 
Port, current connect time%T
Quick Token Reference (Continued)
Function/Purpose of TokenSyntax 
						

							134 Installing [email protected]/Windows
Port number, current%C
Port, transfer code for current%X
Previous mailbox%P
PromptP[
repetition] (
prompt_no,V[,
hangup])
L(
file) 
Pulse dial~
Questions and answersQ({
greeting[#
mailbox][,E]}) 
Read, file{
file}
N(
file,
field,
value{,
field,
variable})
V(
file,
field,
value{,
field,
variable}[,
n])
Recordings, stored as messages or filesKR(
file_or_box[,
recording_info]) 
Records, deleteKV(
file,
field,
value) 
Remote computersS(
port,[
string,[
variable],[
termination],
[
length],[
timeout]) 
Rings, wait for number ofW(
n,
event [,
mailbox]) 
KW[(
rings[,P|V])]
Rotary trainingKT(G
n[,
digit])
Search, file?(
line,
file,
mailbox)
N(
file,
field,
value{,
field,
variable})
V(
file,
field,
value{,
field,
variable}[,
n])
KV(
file,
field,
value) 
Search, stringKI(
target,
source,
variable) 
Security codeKC(
mailbox,
variable) 
KL(
mailbox,
security_code)
 
KP(
mailbox,
security_code) 
Serial port accessS(
port,[
string,[
variable],[
termination],
[
length],[
timeout]) 
Set Name%F(
field[,
mailbox]) 
ShutdownKS[(
errorlevel)] 
Sound volume, change^(
volume_change) 
Quick Token Reference (Continued)
Function/Purpose of TokenSyntax 
						

							Chapter 10: Programming Amanda 135
Space%D
P[
repetition](D) 
SpellP[
repetition](A,
string[,
hangup]) 
String, searchKI(
target,
source,
variable) 
Strings, lengthLEN[
string] 
Subtract+(
variable[,
value]) 
Testing for message notification fileZ[(
file)] 
Time%I(
field,
msg_no[,
mailbox])
P[
repetition](
time,T[,
hangup]) 
Time, connect time%T
Time, current%Z
Timed break recall~
Tokens, processing@
To n e s01 2
34 5
67 8
9A B
CD *#
Total messagesP[
repetition] (M[,
mailbox[,
hangup]]) 
Transfer code for current port%X
Transfer, unsupervised (blind)[
ext_no]H
Transfer, supervisedext_no
ext_noKM
Transferring to specified mailboxG(
mailbox) 
mailbox accessKC(
mailbox,
variable) 
KL(
mailbox,
security_code)
 
KP(
mailbox,
security_code) 
mailbox, current%U
mailbox, Extension field of current%E
mailbox, new message count%N
mailbox, playing Name/Extension 
recordingP[
repetition] (U[,
mailbox[,
hangup]])
Quick Token Reference (Continued)
Function/Purpose of TokenSyntax 
						

							136 Installing [email protected]/Windows
mailbox, previous%P
mailbox, total message count%M[(
mailbox)]
mailbox, value of field%F(
field [,
mailbox])
Variable fieldP[
repetition](V) 
%V
Va r i a b l e s[(
file) 
](
file) 
|(
file) 
+(
variable[,
value]) 
=(
variable,
value[,
start,
end]) 
%G0 %G1 %G2 %G3 %G4
%G5 %G6 %G7 %G8 %G9
%S0 %S1 %S2 %S3
%S4 %S5 %S6 %S7
%S8 %S9 %S10 %S11
%S12 %S13 %S14 %S15
%S16 %S17 %S18 %S19
Variables, shiftK
						

							Chapter 10: Programming Amanda 137
Alphabetical Token Reference 
 Token SyntaxDescription
-Literal that pauses processing for .5 (one-half) second.
, Literal that pauses for 2 seconds. Used when dialing an extension or to introduce a pause 
before processing the next token.
NOTE:
Be careful not to confuse this comma with the separator found in commands and 
records.
?(
line,
file,
mailbox) Command that searches the specified file (line by line) for the specified line. The line 
must match an entire line within the file. If the line is found, processing continues at the 
specified mailbox. If the line is not found, processing continues with the next token. 
lineThe string or variable to be matched as a line in the file. No line in the file should 
exceed 143 characters.
fileA string or variable containing a valid DOS file name for the text file to be searched. 
Use the complete path to the file unless the file is in C:\AMANDA. There is no limit 
to the number of lines in the file.
mailboxA valid mailbox or a variable containing a mailbox. 
Example:
?(%S9,C:\\AMANDA\\FOOBAR.TXT,247)
causes Amanda to search FOOBAR.TXT for a line that matches the characters in %S9. 
If a line is found, Amanda continues processing at mailbox 247.
Failure:  
Invalid mailbox
@Literal that causes Amanda to process the Extension or Notify Method field as a set of 
tokens instead of processing the field normally. 
Normal processing for the Extension field: Amanda plays “Please hold while I try that 
extension,” puts the caller on transfer hold, then evaluates the tokens in the field. The @ 
stops Amanda from performing the dial code that puts a caller on transfer hold (also 
known as the dl_dtwait dial code). As explained in “Using Setup to Define Codes, 
Integration Patterns, and Other Parameters” on page 7, you use the Setup utility 
(selection 1) to set or view the dial codes. The codes are stored in 
C:\AMANDA\PBX.DB\1001.PBX, which you can view or edit using the JOVE utility.
Normal processing of the Notify Method field: Amanda tries to access a port for an 
outbound notification call. The @ stops Amanda from going off-hook. 
						

							138 Installing [email protected]/Windows
 [(
file) Command that reads the first line in the specified file as the first ten port variables (%S0-
%S9). The 10 values in the file must be comma delimited. The first value is %S0, the 
second is %S1, etc. The quotation marks used to delimit strings do not appear in the file, 
but the commas that separate them from the other variables do. For example, empty 
strings take up no space in the file.
This command is usually used with the ]() command to keep track of what the port is 
doing. You read the variables using the [() command, update them, and then write them 
to the file once more using the ]() command. 
Read with the [() command and write with the ]() command within the same field to avoid 
potential simultaneous access errors caused by another port accessing the file.
If the file does not exist, Amanda just goes on to the next token.
fileA string or variable containing a valid DOS file name for the text file to be read. No 
line in the file should exceed 143 characters. There is no limit to the number of lines. 
When you specify a file name, its full path is required unless the file is stored in the 
directory for the current mailbox. For example, if you use [(file) with only a file 
name, and the mailbox number is 101, your file must be located in the 
C:\VMB.DB\1\101 directory or the file cannot be found.
Example:
[(C:\\AMANDA\\FOOBAR.TXT)
places the following line in FOOBAR.TXT
,,,10,,,,5,9,555
In this case %S0, %S1, %S2, %S4, %S5, and %S6 were empty strings.
To count the number of calls, etc. processed by a particular port (or all ports), read the 
variables, add 1 to the contents of the one that stores the count, and write the variables 
back to the file.
[(C:\\AMANDA\\FOOBAR.TXT)+(%S4)] 
(C:\\AMANDA\\FOOBAR.TXT)
If you are counting all ports, use the same file for all ports. If you are counting per port, 
use a different file for each port.
Failure:  Does not fail 
\\Backslash, the actual \ character. Can be used in strings.
Failure:  Does not fail 
\AAttention, which is a bell sound (Ctrl+G). Can be used in strings.
Failure:  Does not fail 
\BCtrl+B. Added for Ericsson MD-110 serial integration. For the MD-110, Ctrl+B is the 
Start of Transmission (STX) character. Can be used in strings.
Example:
@S(3,\B06%Emm\N)
which controls message waiting indicators.
Failure:  Does not fail 
\NNewline (Ctrl+J). Can be used in strings.
Failure:  Does not fail 
\RReturn (Ctrl+M). Can be used in strings.
Failure:  Does not fail 
\T TAB (Ctrl+I). Can be used in strings.
Failure:  Does not fail 
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 10: Programming Amanda 139
](
file) Command that writes the values of the first 10 port variables (%S0–%S9) to the specified 
file. The values are comma-separated and terminated by a carriage return/linefeed. 
Usually used in conjunction with the [() command which reads the %S variables. 
fileA string or variable containing a valid DOS file name for the text file to be written 
to. When you specify a file name, its full path is required unless the file is stored in 
the directory for the current mailbox. For example, if you use ](file) with only a file 
name, and the mailbox number is 101, your file must be located in the 
C:\VMB.DB\1\101 directory or the file cannot be found.
Example:
See the [() command. 
Failure:  
The file is read-only
Insufficient disk space to save file
^(
volume_change) Command that changes the volume of the current port.
volume_changeAmount to increase or decrease the current volume. Use a positive number to 
increase the volume and a negative number to decrease the volume. Use 
the minus sign for negative numbers, but omit the plus sign for positive 
numbers. Amanda gives you a volume as close as possible to what you 
ask for. 
The volume on Brooktrout voice boards ranges from -8 (softest) to +8 (loudest). 
Initially, the volume is set to 0, but that is not necessarily its current 
value. If the value is +8 and you apply a change of -16, the volume’s 
value goes to -8. If the value is 0 and you apply a change of -16, the value 
of the volume goes to -8 and an error appears in the trace file.
If the number you specify takes the volume out of its range, the highest volume 
(8) or the lowest volume (-8) is used instead, depending on which is 
closer to your choice.
Example:
^(8)
raises the volume of the port to its loudest (if it was initially set to 0).
Failure:  
Does not fail
{
file}Command that reads Amanda tokens from an external file. This allows you to exceed the 
65-character limit in the Extension and Notify Method fields. If the file does not exist, 
Amanda just goes on to the next token.
fileA string or variable containing a valid DOS file name. Use the complete path to the 
file unless the file is in C:\AMANDA. The file must be a text file containing valid 
Amanda tokens. No line in the file should exceed 143 characters. There is no limit 
to the number of lines in the file.
N
OTE Since the entire file is read and since white space is ignored, you can make the file easier 
to read by putting one token per line. (White space is tabs, spaces, and carriage return/
linefeeds.)
Example:
{C:\\AMANDA\\RELAY.TXT}
causes Amanda to process the tokens in RELAY.TXT.
Failure:  
Does not fail
The failure of any token within the file causes the rest of the file to be ignored. Then Amanda 
executes the token after the {} token or the RNA chain if there is no token after the {} token.
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							140 Installing [email protected]/Windows
|(
file) Command that appends the first ten %S port variables (%S0–%S9) to the specified file. 
If the file does not exist, Amanda creates it. The values are comma-separated and 
terminated by a carriage return/linefeed.
fileA string or variable containing a valid DOS file name for a text file. Use the 
complete path to the file unless the file is in C:\AMANDA.
Example:
|(C:\\AMANDA\\PORTVARS.TXT)
causes Amanda to add a line to PORTVARS.TXT. You can use this to add a line to 
PORTVARS.TXT every time the port you are tracing changes the value of a variable. 
Later you can review the file.
Failure:  
The file is read-only
Insufficient disk space to save file
~Literal that pulse dials the digit 1 to effect a timed break recall.
+(
variable
[,
value]) Command that allows you to add a number to or subtract a number from the value stored 
in a variable. Usually used to set limits and control programming loops. 
variableOne of port or global variables. 
valueOptional. A number or variable. The default is 1.
Example:
+(%S7,-1)
subtracts 1 from the value stored in %S7.
+(%G6)
adds 1 to the value stored in %G6. 
Failure:  
Does not fail
() command. To fax multiple documents, 
you initiate the process with this command and, as the caller requests faxes, you add the 
file for the requested document using the >() command. The fax is sent automatically 
after the caller hangs up.
phone_noString, number, or variable containing the DTMF digits to be dialed. 
This command is used only in Extension fields.
Example:
(C:\\AMANDA\\PRICES.TXT)>
(C:\\AMANDA\\OPTIONS.TXT)>(C:\\AMANDA\\OPTIONS.TXT)
causes Amanda to call (714)452–5570 (after dialing 9 for an outside line and pausing). 
Then Amanda faxes two files. Duplicate files are ignored.
Failure:  
Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription