NAME
/vs/data/irAPI.rc - IRAPI system-wide parameters
DESCRIPTION
The /vs/data/irAPI.rc file (if present) can contain
name/value pairs that can be used to override the default
values for system-wide parameters associated with IRAPI.
Prior to Intuity CONVERSANT VIS V5.0, several of these
parameters used to be placed in the /vs/data/tsm.rc file
used primarily by TSM. Now with the functionality of TSM
distributed to several processes (including transient IRAPI
applications), the irAPI.rc parameters need to be more
readily accessible. Therefore, DBINIT creates the
devtbl.IRAPI_params shared memory structure that is avail-
able to all processes. This structure includes all valid
parameters for the irAPI.rc file. Suitable default values
are provided for the parameters that are not included in the
irAPI.rc file.
As in prior releases, it is not anticipated that the normal
customer needs to modify these parameters. Customer
engineers and add-on packages may need to modify them in
special situations.
The following parameters can be accessed by using the
irGetGlobalParam(3IRAPI) functions.
DNISWAIT This parameter specifies the number of tries
to obtain DNIS on a Tip/Ring (T/R) channel
before running a default script (if any).
The default is 2.
ANALOG_LOSS_COMP
This parameter specifies the amount of gain
(in dB) to be added to standard gain adjust-
ment for a bridge that includes an analog
(T/R) channel. The default is 0. The range
is -18 to +3 in 3 dB increments.
DIGITAL_LOSS_COMP
This parameter specifies the amount of gain
(in dB) to be added to standard gain adjust-
ment for a bridge that includes only digital
channels. This default is 0. The range is
-15 to +6 in 3 dB increments.
BACKGROUND_OVOL
This parameter specifies the adjustment to
OVOL (output volume level) in percent for
speech being played in the background. The
default is 33. The range is 0 to 100.
DTMF_CONNECTION_TONE
This parameter indicates the DTMF tone (0-9,
A-D, *, or #) that will represent answer
detection when used in conjunction with the
DEFINITY optional feature for DTMF Feedback
to VRU. This parameter can be given the
value 'N' to indicate that answer detection
is not enabled. The default will be 'C'.
This parameter and the
DTMF_DISCONNECTION_TONE must be selected so
that the two tones are be in the same row or
column of a telephone keypad.
DTMF_DISCONNECTION_TONE
This parameter indicates the DTMF tone (0-9,
A-D, *, or #) that will represent the caller
disconnecting (hanging up) when used in con-
junction with the DEFINITY optional feature
for DTMF Feedback to VRU. This parameter can
be given the value 'N' to indicate that
caller disconnection detection is not
enabled. The default will be 'D'. This
parameter and the DTMF_CONNECTION_TONE must
be selected so that the two tones are be in
the same row or column of a telephone keypad.
MAX_SWTTS_DIO This parameter sets the maximum number of
simultaneous Software Text To Speech jobs the
system is capable of performing. The default
value is 0. The minimum value is 0 and the
maximum value is 100.
MAX_EVENT_MONITORS
This parameter sets the maximum number of
simultaneous event monitors possible on the
system. The default value is 1. The minimum
value is 0 and the maximum value is 1000.
LOG_EVENT_MASK This parameter provides a bit mask that can
be used to control whether selected events
and alarms are logged. Generally these
events and alarms are ones that frequently
cause undue concern when they occur, but may
help to warn of otherwise undetected prob-
lems. This parameter must be set to a
numeric value representing one or more of the
bits defined in irDefines.h (the define sym-
bol names cannot be used, only a decimal or
hexadecimal numeric value). Customer systems
should in general not change this value from
the recommended default
(IRD_LOG_EVENT_MASK_DEF), but development and
test systems may want to use 0xffffffff
(IRD_MAXIMUM_LOGGING) to ensure that possible
software problems are identified. The only
bits that currently have meaning are, 0x1
(IRD_LOG_CGEN016) that controls whether race
conditions detected by the digital packfiles
will be logged with a CGEN016 alarm, 0x2
(IRD_LOG_TSM011) that controls whether
failure to collocate echo cancellation
resources and speech recognition resources on
the same SP card will be logged with a TSM011
event, and 0x4 (IRD_LOG_SPIP009) that con-
trols whether VROP not keeping up with the
demands of the SP/SSP card be logged with a
SPIP009 event. Other bits are likely to be
used in future releases.
CGEN_ERRWAIT This parameter is the number of seconds
between CGEN_EXECFAIL or CGEN_DEFOWN alarms
on any given channel. If this parameter is
not set, or set to 0, then no throttling is
done. These alarms are indicative of appli-
cation programing errors and should not, in
general, be throttled. The range is 0 to 60
seconds.
VCHANS This parameter specifies the number of vir-
tual channels to be allocated. The default is
1. The range is 1 to 96.
IDLE_HUNT This parameter specifies the order of hunting
for idle channels. The default is 0. Three
values are permitted: 0 means ascending hunt,
1 means descending hunt, 2 means random hunt.
AD_READ_ONLY This parameter determines the permissions on
the AD table. This default is 0 for
read/write permission. Non-zero implies
read-only permission.
XFER_READ_ONLY This parameter determines the permissions on
the Transfer Security table. This default is
0 for read/write permission. Non-zero
implies read-only permission.
TRACE_BUFFER_SIZE
This parameter determines the number of trace
messages in the trace buffer. The default is
40000. The range is 128 to 40000.
NON_AD_CHAN_LIST
This parameter contains Comma or colon
separated list of channel numbers or channel
ranges for which the Application Dispatch
(AD) process should not be the default chan-
nel owner. The default is null string. The
maximum length is 256 bytes.
AD_CHANNEL_TABLE
This parameter contains the full path file
name for the channel table used IRAPI
library. The default is
/vs/data/ad_channel_table. The maximum
length is 128 bytes.
AD_DNISANI_TABLE
This parameter contains the full path file
name for the DNIS/ANI table used by IRAPI
library. The default is
/vs/data/ad_dnisani_table. The maximum length
is 128 bytes.
AD_DNISANI_SIZE
When the AD DNIS/ANI table (see above for the
pathname of the AD DNIS/ANI table) is
created, it will be contain the number of
entries specified in this parameter. If the
AD DNIS/ANI table already exists, this param-
eter has no effect. To change the number of
entries in an existing table, you must first
run the stop_vs command, delete the current
table, change this parameter to the desired
number of entries in the new table, run the
start_vs command to start the voice system,
and then enter the new entries, using the
assign command. NOTE: All previous entries
will be lost! The default is 1500. The range
is 40 to 40000. NOTE: The use of ranges for
DNIS and ANI can dramatically reduce the
size, and search time, of the AD DNIS/ANI
table.
XFER_ALLOW_TABLE
This parameter contains the full path file
name for the Transfer Security Allow table.
The default is /vs/data/xfer_allow_table.
The maximum length is 128 bytes.
XFER_DENY_TABLE
This parameter contains the full path file
name for the Transfer Security Deny table.
The default is /vs/data/xfer_deny_table. The
maximum length is 128 bytes.
SPEECHDIR This paramter contains the full path direc-
tory name for the speech filesystem used by
the IRAPI library. The default is
/home2/vfs/talkfiles. The maximum length is
128 bytes.
TR_GLARE_TIMEOUT
This parameter indicates the amount of time
in seconds that irCall, irInitCall, or irIn-
itCallGroup will wait for dialtone after
going off-hook on a Tip/Ring channel. If
dialtone (or stutter dialtone) is not
detected within the amount of time specified
by this parameter, an IRE_CALL_DONE or
IRE_CALL_PROG event with modifiers of
IREM_GLARE and IREM_NO_DIALTONE will be gen-
erated indicating that glare was detected on
the applicable channel. The default is 5
seconds. The minimum is 1 second and there
is no explicit maximum.
TR_IGNORE_TT_GLARE
This parameter indicates whether the receipt
of a DTMF touch tone should be considered an
indication of glare on a Tip/Ring channel
while an irCall, irInitCall, or irInitCall-
Group is waiting for dialtone. If
TR_IGNORE_TT_GLARE has the value of 0
(IRD_FALSE), then touch tones received after
going off-hook and before detection of dial-
tone will be treated as a form of glare. An
IRE_CALL_DONE or IRE_CALL_PROG event with
modifiers of IREM_GLARE and IREM_TT will
result. If TR_IGNORE_TT_GLARE has the value
or 1 (IRD_TRUE), then touch tones received
while waiting for dialtone will not be con-
sidered an indication of glare and these
functions will continue to wait for dialtone.
The default value is 0 (IRD_FALSE). Any
value other than 0 or 1 will be treated as a
0 (IRD_FALSE).
STATIC_TIMESLOTS
This parameter is reserved for future use and
must have the default value of 1.
RELEASE_TALK_SLOT
This parameter is reserved for future use and
must have the default value of 1.
SPEECH_ALGO This parameter is the default speech coding
algorithm of speech files stored in the
SPEECHDIR directory. Valid values for this
parameter are the enum names defined in
irAlgorithms.h, e.g., SPEECH_ALGO=IRA_MULAW.
If SSP cards are used for speech playback and
coding then the default value of this parame-
ter is IRA_A_CS32. If LSPS cards are used
for speech playback and coding then the
default value of this parameter is
IRA_OKICS32. If neither SSP nor LSPS cards
are used for speech playback and coding then
the default value of this parameter is
IRA_A_CS32. The IRA_ name is converted by
IRAPI to the corresponding enum and the enum
value is stored in IRP_SPEECH_ALGO.
USE_NTS This parameter tells IRAPI whether to use
number translation services when receiving
numbers from and transmitting numbers to
switches and networks. IRD_FALSE (0) indi-
cates that IRAPI should NOT use the number
translation services (NTS) to translate
incoming/outgoing numbers to/from E.164 for-
mat. IRD_TRUE (1) indicates that IRAPI should
use the number translation services. The
default value is IRD_FALSE (0).
USE_CDR_ This parameter tells IRAPI whether to use
call data recording services when setting up
incoming and outgoing calls. IRD_FALSE (0)
indicates that IRAPI should NOT use the call
data recording (CDR) services. IRD_TRUE (1)
indicates that IRAPI should use the call data
recording services. The default value is
IRD_FALSE (0).
USE_XFER_RESTRICT
This paramter tells IRAPI whether to use its
own transfer restriction tables or let the
application control transfer restrictions.
IRD_FALSE (0) indicates that IRAPI should NOT
consult the transfer restriction tables when
performing a transfer operation. IRD_TRUE
(1) indicates that IRAPI should check the
transfer restriction tables to determine
whether a requested transfer operation is
allowed. The default value is IRD_TRUE (1).
IN_RESTRICT This parameter controls how IRAPI provides
calling party numbers and redirecting party
numbers to applications for incoming calls
only. A value of 0 causes calling and
redirecting numbers to be hidden from appli-
cations. A value of 1 causes calling and
redirecting numbers to be hidden from appli-
cations whenever such numbers are marked res-
tricted. A value of 2 causes calling and
redirecting numbers to be disclosed to appli-
cation along with indications of which
numbers are resticted. The default value is
1.
OUT_RESTRICT This parameter controls how IRAPI processes
calling party numbers and redirecting party
numbers for outgoing calls only. A value of
0 marks all calling and redirecting numbers
restricted. A value of 1 indicates calling
and redirecting number restriction is set on
a call by call basis by the application The
default value is 1.
The following parameters can be accessed by the
irGetVarParam(3IRAPI) functions.
TR_D_RINGTONE_DISCONNECT (via IRVP_RINGTONE_DISCONNECT)
TR_D_BUSYTONE_DISCONNECT (via IRVP_BUSYTONE_DISCONNECT)
TR_D_REORDERTONE_DISCONNECT (via IRVP_REORDERTONE_DISCONNECT)
TR_D_DIALTONE_DISCONNECT (via IRVP_DIALTONE_DISCONNECT)
TR_D_STUTTERDT_DISCONNECT (via IRVP_STUTTERDIALTONE_DISCONNECT)
These parameters are used only by IRAPI and
TSM to help determine whether ring, busy,
reorder, dialtone, or stutter dialtone should
be treated as disconnect events. The default
is IRD_DISCONNECT_NEVER (disabled) for
TR_D_RINGTONE, TR_D_BUSYTONE, and
TR_D_REORDERTONE. The default is
IRD_DISCONNECT_ALWAYS (enabled at all times)
for TR_D_DIALTONE_DISCONNECT and
TR_D_STUTTERDT_DISCONNECT. Possible values
are IRD_DISCONNECT_NEVER (disabled),
IRD_DISCONNECT_DURING_RECORD (enabled during
recording), and IRD_DISCONNECT_ALWAYS
(enabled at all times). If enabled and the
IRE_DISCONNECT_TONE event is set to
IRF_NOTIFY (see irSetEvent(3IRAPI)), IRAPI
applications will receive an
IRE_DISCONNECT_TONE event instead of an
IRE_CALL_PROG event when a ring, busy,
reorder, or dialtone call progrees tone is
received. Applications that wish to be
notified of disconnect tones should set the
IRF_NOTIFY flag for the IRE_DISCONNECT_TONE
event and treat the IRE_DISCONNECT_TONE event
similarly to IRE_DISCONNECT. If enabled, TSM
will treat disconnect tones as a disconnect
event unless an interrupt subroutine is pro-
vided.
The following parameters are only used by TSM and can NOT be
accessed by the irGetGlobalParam(3IRAPI) functions.
DIP_TBL_SIZE This parameter is default hash table size
used by TSM for looking up dynamic DIP names.
The default is 32. The range is 32 to 67.
FAX_TONE_LEVEL This parameter determines the sensitivity
level of CNG tone detection when the parame-
ter IRP_FAX_TONEDETECT is set to IRF_CNG or
IRF_CED. Smaller numbers increase the sensi-
tivity and larger number decrease the sensi-
tivity. This value along with numerous other
factors determine whether the CNG tone can be
detected. Just lowering this value does not
guarantee that the system will detect CNG
tones 100% of the time. The default is 1000.
The range is 0 to 50000.
SPEECH_QUEUE_LIMIT
This parameter is the number of speech queu-
ing instructions, i.e., fsay, say, ftalk,
talk, tchars, tnum, that a TSM script may
execute before forcing speech to be flushed.
The reason for this limit is to prevent a
script from queuing an indefinite number of
phrases and taking up all of system memory.
The default is 256, the minimum value is 32.
TSM_STACK_LIMIT
This parameter is the depth of the TSM script
subroutine stack. The reason for this limit
is to prevent a script from making indefin-
itely deep subroutine calls and taking up all
of system memory. The default is 256, the
minimum value is 32.
SEE ALSO
irGlobalParam(3IRAPI), irSetEvent(3IRAPI),
IrPARAMETERS(4IRAPI)
VERSION
This is version 8/31/00 of this man page.