Amanda Work Group Manual

							Chapter 13: Configuration Reference 191
always_report_queue_
positionIf a caller is on hold and is not the first in the queue of callers waiting for a busy exten-
sion, Amanda lets the caller know where he or she is in the queue. Amanda plays, “There 
are n calls ahead of yours.” just prior to playing the on-hold music. This configuration 
parameter determines whether the caller is notified that he or she is the first in the on-
hold queue.
True or False. The default is False.
If True, Amanda plays, “There are 0 calls ahead of yours.”
If False, Amanda plays only the on-hold music when the caller is the first in the queue.
The default appears in install.cfg as:
set always_report_queue_position false
auto_queueDesigned for callers with rotary telephones so that they can be put “on hold” without 
having to press *.
True or False. The default is False.
If True and if active_hold is False, callers are automatically put “on hold” when they 
reach a busy extension. A custom busy message must explain what’s going on so that 
callers are aware that they are “on hold” and that they can dial other extensions—if they 
prefer.
The default appears in install.cfg as:
set auto_queue false
auto_reportThe name of a previously saved report file in the RPT.DB subdirectory within the 
AMANDA directory which can be executed and printed once each day. When not set, 
no auto reporting is done. 
Use the name of a report file with the extension .RPT. The default is an empty string 
which means that no report file is executed.
To use this feature, verify the following:
The parameter lpt_port must be set to the name of a printer
The printer must be online and have enough paper
See also auto_report_time and lpt_port.
The default appears in install.cfg as:
set auto_report 
auto_report_timeThe time of day at which the report is to be printed (when auto_report is not an empty 
string).
A time of day in 24-hour MMHH format. The default is 0745 (7:45 a.m.).
See also auto_report and lpt_port.
The default appears in install.cfg as:
set auto_report_time 0745
auto_wrapAllows the user to wrap from the last message back to the first if all of the following are 
true and the user presses 1.
This parameter is set to True.
The play_new_first parameter is set to True.
You’re on the last message in your message queue.
You have more than one message.
True or False. The default is False.
The default appears in install.cfg as:
set auto_wrap false
Global Settings (Continued)
ParameterDescription 
						

							192 Installing [email protected]/Windows
beep_freqSpecifies the connect tone’s frequency in Hertz (Hz). 
The range is 300 to 3300. The default is 400.
The default appears in install.cfg as:
set beep_freq 400
beep_volumeSpecifies the volume of all beeps. 
The range is 0 to 32767. The default is 4096, which is a “normal” volume.
The default appears in install.cfg as:
set beep_volume 4096
begin_rec_promptWhen record_menu is True, this parameter controls whether the caller hears Amanda 
prompts or only a beep when recording a message. This parameter has no effect on the 
post-record menu. If the caller presses #, the post-record menu indicates how to rerecord, 
append to, or save a recording.
True or False. The default is True.
When True, Amanda plays, “Begin recording at the tone, finish by pressing # or hanging 
up” before the beep. 
When False, the caller hears only a beep.
See also record_menu and end_rec_menu.
The default appears in install.cfg as:
set begin_rec_prompt true
busycyclesMinimum number of non-ringback cycles necessary before the Brooktrout driver noti-
fies Amanda that the extension is busy.
The default is 2 cycles. The range is 0 to 20. 0 means do not change the current Brook-
trout setting (which is also 2 cycles).
The default appears in install.cfg as:
set busycycles 2
ca_fileThe file (in the C:\AMANDA directory) which stores call accounting (SMDR) data that 
comes from the port in ca_port. The data is collected from the telephone switching sys-
tem, stored while Amanda runs, and then (after a shutdown) read by a call accounting 
package that analyzes and manipulates the data.
Use any filename. The default is SMDR.DAT.
See also ca_port.
The default appears in install.cfg as:
set ca_file SMDR.DAT
ca_portThe number for the logical serial port that will read SMDR data from the switch while 
Amanda is running. The data is stored in the file specified by ca_file unless the number 
is 0, in which case no SMDR data is read.
Use 0, 1, 2, 3, or 4. The default is 0.
See also ca_file.
The default appears in install.cfg as:
set ca_port 0
Global Settings (Continued)
ParameterDescription 
						

							Chapter 13: Configuration Reference 193
caller_idThe number of seconds that the system waits for caller ID information after receiving a 
ring indication on the line and before answering the all.
The range is from 0 to 255. 0 means that caller ID information is not expected and is the 
default.
The captured data appears in the Subject line for outside calls reviewed with Amanda 
Messenger and Amanda Unified Messenger.
The default appears in install.cfg as:
set caller_id 0
cancel_busy_holdDetermines whether callers can hold for a busy extension.
True or False. The default is False.
When True, busy becomes equivalent to Ring No Answer (RNA). That means that the 
caller cannot hold for a busy extension and can only leave a message once RNA or 
BUSY is the state of the called extension (assuming the mailbox accepts messages).
When False, the caller can press * to hold for a busy extension. 
The default appears in install.cfg as:
set cancel_busy_hold false
client_activation_
keyActivation key that validates the value specified by n_clients. It is normally generated 
automatically as the client connections are installed. If you change or add a board later, 
you need another activation key because the key is based on the serial number for the 
first board. The first board is based on its low I/O port number (the first Brooktrout board 
is usually 300H). Get the key from an Amanda Company sales representative. 
The default is 0, which means there is no client activation key. 
See also n_clients.
The default appears in install.cfg as: 
set client_activation_key 0
cmt_maxlenSets the total number of seconds allowed for recording a List Comment. The user can 
record a comment while creating a mailing list or later. It names or describes the contents 
of the list.
Number of seconds. The range is from 1 to 99. The default is 10.
The default appears in install.cfg as:
set cmt_maxlen 10
connect_toneWhen an answer is detected and Amanda is not identifying the called party for the cur-
rent mailbox, this parameter determines whether Amanda plays a beep. (On the Admin-
istrator client, the mailbox’s Identify Called Party check box is cleared.)
True or False. The default is True.
When True, Amanda plays the beep.
When False, there is no beep.
The default appears in install.cfg as:
set connect_tone true
Global Settings (Continued)
ParameterDescription 
						

							194 Installing [email protected]/Windows
create_lockedControls whether or not new mailboxes are locked when the mailbox template (usually 
mailbox 997) is locked. The administrator (using mailbox 999 and the telephone) can 
lock the template (and other mailboxes) using one of the system administration param-
eters. This prevents callers from logging into the mailbox template. 
True or False. The default is False.
When True, new mailboxes created from the template are initially locked if the template 
is locked.
When False, new mailboxes are not locked. This means that they can be logged into via 
the telephone immediately after they are created.
The default appears in install.cfg as:
set create_locked false
db_lockingMakes Amanda lock each record in a file as it is accessed. No other port or program can 
access that record of that file. This is used within the context of using tokens to read and 
write to ASCII or dBase files. 
The value is True or False. The default is False.
When True, Amanda attempts to perform record locking which will fail unless 
SHARE.EXE, a DOS program (not licensed via The Amanda Company), is running. 
This program is usually loaded by the CONFIG.SYS or AUTOEXEC.BAT file. 
When False, Amanda does not perform record locking.
The default appears in install.cfg as:
set db_locking false
defaults_boxIndicates what mailbox to use as a template when creating a new mailbox. The contents 
of most fields, all notification records, and all automatic scheduling records are copied 
from the template to the new mailbox. The Comment and Directory Name fields are not 
copied. The Extension field is copied only if it begins with an @ (which indicates token 
programming).
If the Security Code field of the default mailbox is blank, the security codes for new 
mailboxes are their mailbox numbers. Otherwise, the security codes for all new mailbox-
es are the same as that of the template mailbox. The Security Code field always appears 
blank. You must fill it with spaces if you want it to actually be blank.
Use any valid mailbox. The default is 997.
See also guest_defaults.
The default appears in install.cfg as:
set defaults_box 997
dialer_max_portSpecifies the highest Amanda telephone port to be considered for use when Amanda Di-
aler dials a number. The range is 0 to the highest port number available. 
The default is 0. When dialer_min_port and dialer_max_port are both 0, Amanda uses 
all ports. 
The default appears in install.cfg as:
set dialer_max_port 0
dialer_min_portSpecifies the lowest Amanda telephone port to be considered for use when Amanda Di-
aler dials a number. The range is 0 to the highest port number available. 
The default is 0. When dialer_min_port and dialer_max_port are both 0, Amanda uses 
all ports. 
The default appears in install.cfg as: 
set dialer_min_port 0
Global Settings (Continued)
ParameterDescription 
						

							Chapter 13: Configuration Reference 195
did_dtmfIndicates what kind of integration digits Amanda reads when did_mode is True. 
True or False. The default is True.
When True, Amanda expects either MF or DTMF digits. 
When False, Amanda expects the digits as pulse.
See also did_mf and did_mode.
The default appears in install.cfg as:
set did_dtmf true
did_mfDetermines what kind of integration digits Amanda reads when did_dtmf is True and 
did_mode is True. Otherwise, Amanda ignores this parameter.
True or False. The default is False.
When True, Amanda expects MF digits.
When False, Amanda expects DTMF digits.
See also did_dtmf and did_mode.
The default appears in install.cfg as:
set did_mf false
did_modeIndicates whether Amanda is using DID. 
True or False. The default is False.
When True, Amanda expects a DID interface (such as EXACOM) that processes a hook-
flash as battery reversal.
When False, Amanda does not expect a DID interface.
The default appears in install.cfg as:
set did_mode false
dir_formatDetermines how names associated with mailboxes in the employee directory are format-
ted for the client applications. %1 expands to the Directory Name 1 field, %2 to 
the Directory Name 2 field, and %c to the Comment field. Other characters (such 
as space) are taken literally. The most common value is %1 %2. 
The default is %1 %2. 
The default appears in install.cfg as:
set dir_format %1 %2
direct_loginControls whether the caller can call himself, and press an asterisk to hear the prompt for 
the security code.
True or False. The default is False.
When True, pressing a single asterisk (*) causes the caller to be prompted for the current 
mailbox’s security code. This is useful in DID situations where the call has already 
reached his own box and is simply trying to log in.
When False, pressing * has no effect.
The default appears in install.cfg as:
set direct_login false
Global Settings (Continued)
ParameterDescription 
						

							196 Installing [email protected]/Windows
diskwarnWhen Amanda has only the specified percentage of disk space left, the system executes 
Disk notification record (if there is one) for mailbox 999. The notification record may 
call you at home, call your extension, call your pager, and so forth. For example, use 20 
to have Amanda notify you when the remaining disk space falls below 20. 
Number (for a percentage). The range is from 1 to 99. The default is 20.
See also tmo_disk.
The default appears in install.cfg as:
set diskwarn 20
dl_pickup If this string is defined and dl_pickup_on_ring is set to true, Amanda will dial the tokens 
in the dl_pickup string before beginning to process an incoming call.
The default appears in install.cfg as:
set dl_pickup 
dl_pickup_on_ringWhen an inbound ring is detected and Amanda goes off-hook, this parameter determines 
whether Amanda dials the code specified by the dl_pickup parameter in the 1001.PBX 
file or the current dial codes file for that port.
True or False. The default is False.
When True, Amanda dials the code.
When False, Amanda does not dial the code.
The default appears in install.cfg as:
set dl_pickup_on_ring false
dtmf_action
dtmf_busy
dtmf_dnd
dtmf_ring
dtmf_xfer
tmo_xferThe dtmf_action, dtmf_busy, dtmf_dnd, dtmf_ring, dtmf_xfer, and tmo_xfer, parame-
ters are required only for telephone switching systems, such as Comdial DXP and Pana-
sonic KXT-D, that can send DTMF tones in place of PCPM tones. 
For Comdial DXP, The Amanda Company recommends dtmf_action=1, dtmf_busy=2, 
dtmf_dnd=3, and dtmf_xfer=1. (It sends nothing for a ring—dtmf_ring=.) 
tmo_xfer=50 and tmo_rna=25 have been recommended.
For Panasonic KXT-D, The Amanda Company recommends dtmf_action=1, 
dtmf_ring=1, dtmf_busy=2, dtmf_dnd=4, dtmf_xfer=5, and tmo_xfer=20. 
tmo_xfer is the number of tenths of seconds that Amanda waits to read a sequence of 
DTMF digits from the port prior to doing PCPM. The range is 0 to 255. The default is 0, 
which disables this and the following parameters. (If this parameter is blank, the default 
is used.)
If the tmo_xfer timeout is greater than 0, Amanda waits for digits until the timeout oc-
curs.
The digits the system might read are:
dtmf_xferThis sequence of digits means that the extension has been answered. 
Amanda releases the call. The default is an empty string (no digit).
N
OTE:The telephone switching system should bring the call 
back to the port if this digit is sent when the phone is 
ringing rather than actually answered.
C
AUTION:When using call screening, be aware that this will play 
the callers name and company as well as the call 
screening menu to a ringing tone.
Global Settings (Continued)
ParameterDescription 
						

							Chapter 13: Configuration Reference 197
 (cont.)
dtmf_action
dtmf_busy
dtmf_dnd
dtmf_ring
dtmf_xfer
tmo_xferdtmf_dndThis sequence of digits means that the extension is in Do Not Disturb 
mode. Amanda treats the call as though it were not answered (RNA). 
The default is an empty string (no digit).
dtmf_busyThis sequence of digits means that the extension is busy so Amanda 
performs no PCPM. The default is an empty string (no digit).
dtmf_ringThis sequence of digits causes Amanda to stop waiting or to extend her 
wait, depending on the value of dtmf_action. The default is an empty 
string (no digit).
no digit If Amanda reads no sequence of digits before the tmo_xfer timeout oc-
curs, the system stops waiting or extends her wait, depending on the 
value of dtmf_action.
The dtmf_action parameter determines what Amanda does if the system receives the dig-
its specified in dtmf_ring or if the timeout specified by tmo_xfer occurs before the digits 
arrive.
When 0 (the default), Amanda performs normal PCPM. 
When 1, Amanda continues to wait for the digits. The system waits 6 seconds for each 
of the rings specified for a Ring No Answer (RNA). For example, if the mailbox has 4 
rings for RNA, Amanda waits 24 seconds. Then the system decides that the call is not 
answered.
For COMDIAL, see also dtmf_dt.
The defaults appear in install.cfg as:
set dtmf_action 0
set dtmf_busy 
set dtmf_dnd 
set dtmf_ring 
set dtmf_xfer 
set tmo_xfer 10
dtmf_before_ringControls whether Amanda clears the voice board’s DTMF buffer when a ring is detected. 
Clearing the buffer gets rid of digits left over from a previous call.
True or False. The default is False.
When True, the buffer is not cleared. Make sure the telephone switching system can send 
DTMF before a ring prior to changing this to True.
When False, Amanda clears the buffer when a ring is detected. You must use False for 
Brooktrout 2132 and 4132 because they cannot detect DTMF while on-hook.
The default appears in install.cfg as:
set dtmf_before_ring false
dtmf_busyThis parameter is required only for telephone switching systems, such as Comdial DXP 
and Panasonic KXT-D, that can send DTMF tones in place of PCPM tones. See also 
dtmf_action.
dtmf_dndThis parameter is required only for telephone switching systems, such as Comdial DXP 
and Panasonic KXT-D, that can send DTMF tones in place of PCPM tones. See also 
dtmf_action.
Global Settings (Continued)
ParameterDescription 
						

							198 Installing [email protected]/Windows
dtmf_detectHow long a DTMF tone must play for Amanda to recognize that it has occurred. 
Number from 2 to 6, each representing 16 ms. (For example, 3 equals 48 ms or .048 sec-
onds.) The default is 0.
Zero means to use the default. The default is 3 (.048 seconds). 
When non-zero, both Brooktrout’s DTMFDetect and DTMFDelay channel parameters 
are set to that value. 
The default appears in install.cfg as:
set dtmf_detect 0
dtmf_dlyControls the amount of time between DTMF tones when Amanda is dialing. 
Number of hundredths of seconds. The value is 0 or a number from 3 to 19. The default 
is 0.
Using a value of 0 makes it country-dependent (50ms in the US, 80ms in the UK). When 
non-zero, the specified time is used.
The default appears in install.cfg as:
set dtmf_dly 0
dtmf_dtThe string of DTMF digits received instead of a dial tone. For example, COMDIAL 
sends a 1.
The string can be any length. The default is an empty string which means that Amanda 
waits for the dial tone.
If dtmf_dt is not an empty string, and if tmo_dtwait (the dial code that determines how 
long to wait for a dial tone or its equivalent) is > 0, Amanda dials dl_dtwait (the dial code 
that puts the caller on transfer hold) and then waits for the dtmf_dt digits to come from 
the switch.
If Amanda receives fewer digits or if the digits do not match dtmf_dt, Amanda assumes 
the extension is busy. If Amanda receives the expected digits, the system proceeds with 
the call. As soon as Amanda receives the correct number of digits, the system stops wait-
ing regardless of the value of tmo_dtwait. Therefore, it should be safe to make 
tmo_dtwait substantially larger than the actual time expected.
The default appears in install.cfg as:
set dtmf_dt 
dtmf_gateVerifies that the caller is still on the line before transferring him to the operator. This ap-
plies only if the mailbox (usually the operator) specified in the Done Chain for the Caller 
Instructions mailbox has Do Not Disturb turned off.
True or False. The default is False.
When True, Amanda verifies that the caller is still on the line after playing the Caller In-
structions and not hearing any DTMF. Amanda asks the caller to “Say ‘yes’ at the tone” 
before transferring the call. For example, on telephone switching systems that do not 
have disconnect supervision, this can prevent the transfer of a call to the operator or pre-
vent the replaying of a menu when the caller has hung up.
When False, Amanda transfers the call without verifying that the caller is still on the line. 
The default appears in install.cfg as:
set dtmf_gate false
Global Settings (Continued)
ParameterDescription 
						

							Chapter 13: Configuration Reference 199
dtmf_onControls how long Amanda plays each DTMF tone. 
Number in hundredths of seconds. The range is from 10 to 90. The default is 20 (.2 sec-
onds). 
The default appears in install.cfg as:
set dtmf_on 20
dtmf_ringThis parameter is required only for telephone switching systems, such as Comdial DXP 
and Panasonic KXT-D, that can send DTMF tones in place of PCPM tones. See also 
dtmf_action.
dtmf_xferThis parameter is required only for telephone switching systems, such as Comdial DXP 
and Panasonic KXT-D, that can send DTMF tones in place of PCPM tones. See also 
dtmf_action.
end_rec_menuWhen record_menu is True, this parameter determines whether the caller hears the post-
record menu that allows callers or users to review or re-record their messages or greet-
ings.
True or False. The default is True.
When True, the caller or user hears the menu.
When False, the caller or user does not hear the menu.
The default appears in install.cfg as:
set end_rec_menu true
exit_digitDefines one additional DTMF tone that causes Amanda to stop during recordings 
(whether greetings or messages) and play the post-record menu.
The range is from 0 to 9 and also includes * and #. The default is #. Remember that the 
# key always causes Amanda to stop recording, even when it is not the value of 
exit_digit. 
The default appears in install.cfg as:
set exit_digit #
exit_to_0Allows a caller to leave a message and talk to the operator afterwards.
True or False. The default is True.
When True, the caller can press 0 after recording a message and is transferred to mailbox 
0.
When False, Amanda records the DTMF 0 as part of the message unless 0 is defined as 
an exit digit (see exit_digit).
N
OTE:Regardless of the setting for exit_to_0, a caller can press 0 during the “Begin 
recording at the tone...” prompt and go to mailbox 0 immediately. If the call-
er presses any other key (1-9, #, *), Amanda stops the prompt, plays the 
beep, and starts recording the message.
The default appears in install.cfg as:
set exit_to_0 true
Global Settings (Continued)
ParameterDescription 
						

							200 Installing [email protected]/Windows
fast_forwardAllows you to use an alternate TUI (telephone user interface) for forwarded messages.
True or False. The default is False.
When True and a user forwards a message, the alternate TUI asks you for the destination 
mailbox number, confirms your choice by playing that mailbox owner’s name and ex-
tension recording, and asks for a prefix. Then you hear the post record menu and your 
message is sent as you save it. This minimizes keystrokes when forwarding a message.
The default appears in install.cfg as:
set fast_forward false
fast_forward_n_preControls the recording of a prefix message during a fast forward. See fast_forward.
True or False. The default is False.
When True, a prefix cannot be recorded.
When False, the prefix can be recorded.
The default appears in install.cfg as:
set fast_forward_n_pre false
fast_send_msgControls the menu options available for sending or forwarding messages.
When True, Amanda plays a stream-lined menu. When the logged-on user presses 4 (to 
send) or 5 (to forward), Amanda expects the user to enter the mailbox number, a personal 
mailing list number preceded by a *, or a system mailing list number preceded by **. 
When the user presses # after selecting a recipient (or a list of recipients), Amanda 
expects the user to record the message. After recording the message, the post-record 
menu is slightly different: the user can press 8 to send the message with verification or 
9 to send the message without verification. 
When False, users must press 1 to designate a recipient and 2 to record. With the longer 
version of the post-record menu, after pressing 9 to save the message, verification is 
handled by pressing 5 (a 3 sends it without verification).
In both cases, other options, such as setting a future delivery date are available.
True or False. The default is True.
The default appears in install.cfg as:
set fast_send_msg true
fax_monitorNotifies the sending mailbox about fax transmission.
True or False. The default is True.
When True, the sending mailbox receives a message that the fax has been transmitted or 
that it failed.
When False, the fact that a fax has been transmitted is not reported back to the sending 
mailbox.
This parameter applies to both fax modems and BrookTrout TruFax/200 boards.
The default appears in install.cfg as:
set fax_monitor true
future_deliverySpecifies the mailbox that stores messages to be delivered in the future. This mailbox 
must be able to store messages.
The default is 995, but you can use any valid mailbox. -1 means no mailbox has been 
assigned. 
The default appears in install.cfg as:
set future_delivery 995
Global Settings (Continued)
ParameterDescription