Amanda Work Group 7xx Installation Manual

							Chapter 11: Programming Amanda 179
Variables[(
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
						

							180 Installing [email protected]
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.
N
OTE:
Be careful not to confuse this comma with the separator found in com-
mands 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 con-
tinues 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 Installing 
[email protected]/DOS, 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. 
						

							Chapter 11: Programming Amanda 181
 [(
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.
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. Can be used in strings.
Failure:  Does not fail 
\NNewline (Ctrl+J). Can be used in strings.
Failure:  Does not fail 
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							182 Installing [email protected]
\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 
](
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. Use the complete path to the file unless the file is in 
C:\AMANDA.
Example:
See the [() command. 
Failure:  
The file is read-only
Insufficient disk space to save file
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 183
^(
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 possi-
ble 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.
For tAA voice boards, the volume ranges from 1 (the soft-
est) to 9 (the loudest). Initially, the volume is set to 5, but 
that is not necessarily its current value. If the volume is 5, 
and you apply a change of 4, the volume goes to 9. If you 
apply a change of 6, the volume goes to 9 and Amanda 
ignores the fact that you asked for more volume than was 
available.
Example:
^(8)
raises the volume of the port to its loudest.
Failure:  
Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							184 Installing [email protected]
{
file}Command that reads Amanda tokens from an external file. This allows you to ex-
ceed 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 com-
plete 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.
|(
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.
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							Chapter 11: Programming Amanda 185
+(
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 doc-
uments, you initiate the process with this command and, as the caller requests fax-
es, 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 di-
aled. 
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 paus-
ing). Then Amanda faxes two files. Duplicate files are ignored.
Failure:  
Does not fail
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription 
						

							186 Installing [email protected]
=(
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.
endOptional, but must be used if start is used. The last character posi-
tion to copy from value.
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. 
>(
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 
						

							Chapter 11: Programming Amanda 187
%ASystem variable containing the value of the fax_dl_init configuration setting. 
Example:
If %A is 9,, a 9 followed by a pause is needed to access an outside telephone line.
%B1 %B2
%B3 %B4
%B5 %B6System variable that contains the serial number of the corresponding voice board. 
%B1 is voice board 1, %B2 is voice board 2, etc.
%CSystem variable that contains the port number. Each port has its own %C. For ex-
ample, if the current caller is on Port 3, %C contains a 3.
%DSystem variable that contains the percentage of free disk space. Example:
I(%D,
						

							188 Installing [email protected]
%F(
field
[,
mailbox
])
 System variable that contains the value of the specified field for the specified mail-
box. 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 (if your system uses Brooktrout voice 
boards) or for the Set Name field (if your system is connected 
to a Norstar KSU)
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 
telephone 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)
Alphabetical Token Reference (Continued) 
 Token SyntaxDescription