Oracle® Voicemail & Fax Administrator's Guide 10g Release 1 (10.1.1) Part Number B14496-03 |
|
|
View PDF |
This appendix describes the Voicemail & Fax parameters. The parameters are set on the administration pages for the Voicemail & Fax group, Voicemail & Fax Application, and each of the services.
Note:
Not all parameters apply at each level of the hierarchy or for each of the services.The Database Buffers parameters specify the size of the read and write buffers.
Table B-1 Database Buffers Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Collaboration Suite Database Read Buffer Size |
Specifies the amount of data that is read from the database in one read operation during retrieval of voicemail messages. |
Valid Values: Positive integer Default Value: 102400 bytes |
Collaboration Suite Database Write Buffer Size |
Specifies the amount of data that is written to the database in one write operation during the sending of voicemail messages. |
Valid Values: Positive integer Default Value: 524288 bytes |
General parameters do not fit any other category of parameters. The general parameters for each of the services is described in the sections that follow.
There is only one parameter for the Call Transfer Service, Fax Receiving Service, Interactive Voice Response Service, and SMDI Monitor Service.
The following are the general parameters for the Message Delivery Monitor Service.
Table B-3 General Parameters for the Message Delivery Monitor Service
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Process Sleep Duration |
Test messages are sent from the Oracle Voicemail & Fax system to a test account on the Collaboration Suite Database. Process Sleep Duration specifies the time interval between test messages. |
Valid Values: 0 – 2147483647 seconds Default Value: 600 seconds |
The following are the general parameters for the Message Waiting Indicator Service.
Table B-4 General Parameters for Message Waiting Indicator Service
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Process Sleep Duration |
Number of milliseconds a MWI service instance thread sleeps between back-to-back MWI requests. |
Valid Values: Positive integer Default Value: 250 |
Collaboration Suite Database Physical Connection Time |
Number of seconds a physical database connection between an MWI service instance and Collaboration Suite Database is idle before the connection is broken. |
Valid Values: Positive integer Default Value: 3600 |
MWI Mode |
In Dispatch mode, the MWI Service processes Collaboration Store Database requests. In Notify mode, the MWI Service sets the message waiting indicator on the PBX. |
Valid Values: Dispatch and Notify, Dispatch, Notify Default Value: Dispatch and Notify |
The following are the general parameters for the Recording Service.
Table B-5 General Parameters for the Recording Service
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Threads Per Process |
Number of threads for this service within one JVM. |
Valid Values: A positive value. Default Value: 4 |
Transfer Application DN |
Distinguished name entry for the transfer service. This is the service that calls are routed to when a user chooses to transfer to an attendant. |
Valid Values: A valid Oracle Internet Directory distinguished name Default Value: cn=%LDAPComputerName% : %installhome% : transfer, cn=ovf, cn=%ct_orahome%, cn=%LDAPComputerName%, cn=Computers, cn=oraclecontext |
Fax Receiving Application DN |
Distinguished name entry for the fax receiving service. This is the service to which fax calls are routed. |
Valid Values: A valid Oracle Internet Directory distinguished name Default Value: cn=%LDAPComputerName% : %installhome% : faxrecv, cn=ovf, cn=%ct_orahome%, cn=%LDAPComputerName%, cn=Computers, cn=oraclecontext |
The following are general parameters for the Retrieval Service.
Table B-6 General Parameters for the Retrieval Service
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Threads Per Process |
Number of worker threads for this service within one JVM. |
Valid Values: A positive value. Default Value: 4 |
Recording Application DN |
Distinguished name entry for the recording service. This is the service to which forwarded calls are routed. Forwarded calls are calls to the voicemail system to record a voicemail or to send a fax. |
Valid Values: A valid Oracle Internet Directory distinguished name Default Value: cn=%LDAPComputerName% : %installhome% : recording, cn=ovf, cn=%ct_orahome%, cn=%LDAPComputerName%, cn=Computers, cn=oraclecontext |
Transfer Application DN |
Distinguished name entry for the transfer service. This is the service that calls are routed to when a user chooses to transfer to an attendant. |
Valid Values: A valid Oracle Internet Directory distinguished name Default Value: cn=%LDAPComputerName% : %installhome% : transfer, cn=ovf, cn=%ct_orahome%, cn=%LDAPComputerName%, cn=Computers, cn=oraclecontext |
The following are the general parameters for the Routing Service.
Table B-7 General Parameters for the Routing Service
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Threads Per Process |
Number of worker threads for this service within one JVM. |
Valid Values: A positive value. Default Value: 4 |
Retrieval Application DN |
Distinguished name entry for the retrieval service. When a call is made to the voicemail system to retrieve voicemail messages, the call is routed to this service. |
Valid Values: A valid Oracle Internet Directory distinguished name Default Value: cn=%LDAPComputerName% : %installhome% : retrieval, cn=ovf, cn=%ct_orahome%, cn=%LDAPComputerName%, cn=Computers, cn=oraclecontext |
Recording Application DN |
Distinguished name entry for the recording service. This is the service to which forwarded calls are routed. Forwarded calls are calls to the voicemail system to record a voicemail or to send a fax. |
Valid Values: A valid Oracle Internet Directory distinguished name Default Value: cn=%LDAPComputerName% : %installhome% : recording, cn=ovf, cn=%ct_orahome%, cn=%LDAPComputerName%, cn=Computers, cn=oraclecontext |
Transfer Application DN |
Distinguished name entry for the transfer service. This is the service that calls are routed to when a user chooses to transfer to an attendant. |
Valid Values: A valid Oracle Internet Directory distinguished name Default Value: cn=%LDAPComputerName% : %installhome% : transfer, cn=ovf, cn=%ct_orahome%, cn=%LDAPComputerName%, cn=Computers, cn=oraclecontext |
Telephony Port Map |
Mapping of the Telephony Server's card port and device numbers to agent line numbers. If the machine belongs to a PBX that uses the SMDI integration type, the default values must be changed after the Voicemail & Fax Application is installed. |
Valid Values: Space delimited pairs of device name and agent line number values Default Values: blt1LSI1 507654321 blt1LSI2 501234567 |
The Internet Directory parameters specify the Oracle Internet Directory (OID) that the Recording Service retrieves recipient information from and specify connection pool characteristics.
Note:
Some parameters apply to some components and not to others. Therefore, you may not see every parameter shown here on your page.Table B-8 Internet Directory Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Process Refresh Interval |
Length of time, in seconds, between attempts by the service to refresh itself. |
Valid Values: Positive integer Default Value: 3600 |
Query Timeout |
Length of time, in milliseconds, that an Oracle Internet Directory query may run before the system abandons the query. |
Valid Values: Positive integer Default Value: 4000 |
Initial Connection Pool Size |
Number of Oracle Internet Directory connections that are created at application startup. |
Valid Values: Positive integer Default Value: 1 |
Minimum Connection Pool Size |
Minimum number of simultaneous Oracle Internet Directory connections that an application may use. |
Valid Values: Positive integer Default Value: 1 |
Maximum Connection Pool Size |
Maximum number of simultaneous Oracle Internet Directory connections that an application may use. |
Valid Values: Positive integer Default Value: 1, plus the number of worker threads that the application uses |
Connection Pool Increment Size |
Number of new Oracle Internet Directory connections to create when all OID connections are in use. |
Valid Values: Positive integer Default Value: 1 |
Connection Timeout |
Length of time, in seconds, that an Oracle Internet Directory connection may be idle before it is released from the OID connection pool. |
Valid Values: Positive integer Default Value: 3600 |
Search Base for E-mail Users |
Distinguished name of the Oracle Internet Directory subtree that will be searched for e-mail users. Oracle Voicemail & Fax services will only be able to find e-mail users in this subtree. |
Valid Values: A valid Oracle Internet Directory distinguished name. Default Value: cn=EmailServerContainer,cn=products,cn=oraclecontext |
Search Base for Voicemail Users |
Distinguished name of the Oracle Internet Directory subtree that will be searched for voicemail users. Oracle Voicemail & Fax services will only be able to find voicemail users in this subtree. |
Valid Values: A valid Oracle Internet Directory distinguished name. Default Value: cn=UMContainer,cn=products,cn=oraclecontext |
Search Base for Voicemail Processes |
A container in Oracle Internet Directory that holds all the Oracle home and process-level configuration for all Oracle Voicemail & Fax Applications. |
Valid Values: An Oracle Internet Directory distinguished name Default Value: cn=Computers,cn=OracleContext |
The log parameters configure logging for the service.
Note:
Some parameters apply to some components and not to others. Therefore, you may not see every parameter shown here on your page.Table B-9 Log Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Full Path for Log Directory |
Directory where log files are written. |
Valid Values: Path name of a file system directory. Default Values: On Windows: %ORACLE_HOME%\um\log |
Specifies the type of logging performed by the UM process |
Valid Values: INTERNALERROR. Reports only critical errors. ERROR. Reports all errors. WARNING. Reports all errors and warnings. NOTIFICATION. Reports high level flow of operations within the process. TRACE. Reports all debugging information. Default Value: WARNING |
|
Maximum size of each log file, in bytes. Once this size is exceeded, another log file is created. |
Valid Values: A positive integer Default Value: 500000 |
|
Maximum Number of Log Files |
Maximum number of log files to write for a process. Once the maximum number of log files has been written and all log files are full, the oldest log file is overwritten. |
Valid Values: A positive integer Default Value: 10 |
Note:
The TRACE option should never be used during normal business operations because it can impact process performance.The PBX-Application Cluster parameter specifies the name of the PBX-Application Cluster associated with this Voicemail & Fax Application.
Table B-10 PBX-Application Cluster Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
PBX-Application Cluster Name |
Name of the PBX-Application Cluster that this Voicemail & Fax Application is associated with. |
Valid Values: Valid characters include alphanumeric characters, spaces, dashes, underscores, and colons. Must not exceed 256 characters. Default Value: None |
Note:
Some parameters apply to some components and not to others. Therefore, you may not see every parameter shown here on your page.Table B-11 Process Management Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Frequency of Process Alive Notifications |
Frequency with which the Oracle Voicemail & Fax Services return a notification to OPMN that the process is alive. |
Valid Values: Numeric String Default Value: 60 seconds |
Maximum Queued Process Administration Requests |
Maximum number of requests that may be queued at the process administration port. |
Valid Values: Positive integer Default Value: 25 |
Secure Process Administration Communication |
Specifies whether process administration requests made to the Voicemail & Fax Services need to be secured. |
Valid Values: Boolean Default Value: True |
Process Administration Request Timeout |
Time out (in milliseconds) for a request made to the process administration port. |
Valid Values: Positive integer Default Value: 3600000 ms |
Table B-12 Recording Process Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Maximum Greeting Play Time |
The maximum length of silence, in milliseconds, permitted before the system plays a user's greeting. If the system is unable to obtain the user's greeting from Oracle Internet Directory (OID) in the specified time, the system uses a more generic greeting based on the user's phone number or recorded name, depending on what information was obtained. If this parameter is not set, there is no time limit besides that which is imposed by Oracle Internet Directory on each OID query. |
Valid Values: A positive integer to indicate that a time out is in use or Not Set to indicate that a time out is not in use. Default Value: Not Set |
Note:
Some parameters apply to some components and not to others. Therefore, you may not see every parameter shown here on your page.Table B-13 Recovery Process Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Process Sleep Duration |
Frequency with which Message Recovery Service checks to see if there are queued messages on the file system |
Valid Values: Numeric string Default Value: 900 seconds |
Message Queue Location |
Location where messages are queued. |
Valid Values: Valid path name of a file system directory Default Value: %ORACLE_HOME%\um\queue |
These parameters are used to configure PBXes that are enabled for Simplified Message Desk Interface (SMDI) to work with the Voicemail & Fax application.
Table B-14 SMDI Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Terminal Map |
Mapping of SMDI message desks to identifiers. The Terminal Map is entered as a list of entries delimited by a new line. The format for the mapping is: message_desk_number terminal_number description Example: 1 1 44001 1 2 44002 1 3 44052 1 4 44006 2 1 45001 2 1 45003 2 3 42643 2 4 42662 |
Valid Values: A list of entries in the prescribed format. Default Values: 5 4 44030 6 1 44121 6 2 44122 6 3 44123 10 1 44000 10 2 44001 10 3 44003 10 4 44003 5 3 44029 3 2 44017 |
Emulation Type |
Protocols used by the SMDI Monitor Service to retrieve call details and make MWI requests. |
Valid Values: SMDI, MD110 (Ericsson MD110 protocol), NEC (NEC MCI protocol), OnHook, and OffHook Default Value: SMDI |
Baud Rate |
Rate, in bits per second, that data is transferred. This setting must be identical to the data transfer rate configured on the PBX. |
Valid Values: Positive integer Default Value: 4800 |
Number of Data Bits |
Number of data bits sent as one byte. |
Valid Values: Positive integer Default Value: 7 |
Number of Stop Bits |
Number of stop bits sent at the end of one byte. |
Valid Values: Positive integer Default Value: 1 |
Parity Type |
Type of parity bit. |
Valid Values: E = Even N = None O = Odd M = Mark S = Space Default Value: E |
Serial Port |
On Microsoft Windows machines, this port is often COM1 or COM2. |
Valid Values: A valid serial port Default Value: COM1 |
Port Number for TCP Connections |
Port number on which the SMDI monitor accepts connections. |
Valid Values: A valid TCP port number Default Value: 7000 |
Ping Time |
Length of time, in milliseconds, between ping messages. This parameter is required by some PBXes to keep the datalink alive. If set to -1, no ping messages are sent. |
Valid Values: Positive integer Default Value: 60000 |
The Telephony Server parameters are used to register the application with the Telephony Server.
Note:
Some parameters apply to some components and not to others. Therefore, you may not see every parameter shown here on your page.Table B-15 Telephony Server Parameters
Parameter Name | Description | Valid Values/Default Value |
---|---|---|
Name |
Host name of the Telephony Server. |
Valid Values: A valid host Default Value: localhost |
Group Configuration |
Name of the Telephony Server group configuration that represents a collection of resources, such as the Player, Signal Detector, Signal Generator, and Fax Receiver. |
Valid Values: A valid Telephony Server group configuration Default Value: UMMediaServicesProfile (for all services except the Fax Receiving Service. UMFaxMediaServices (for the Fax Receiving Service) |
Application Service Name |
Telephony Server application service identifier (ASI). This is the name the Oracle Voicemail & Fax Service uses to register itself with the Telephony Server. Each service is identified by its ASIs which are defined in the application profile. |
Valid Values: A valid Telephony Server application service name Default Value depends on the service: CallTransferService, FaxReceivingService, InteractiveVoiceResponseService, MessageRecoveryService, MWIService, RecordingService, RetrievalService, RoutingService, SMDIMonitorService, TelephonyMonitorService |
Application Profile |
Specifies the name of the Telephony Server profile that contains application configuration information. The application profile contains information on the signal processing resources the application requires, declares the application service identifiers (ASIs) the application uses to identify itself to the Telephony Server, and documents the ASIs that the application uses to identify other applications to hand off calls to. |
Valid Values: A valid Telephony Server profile name Default Value: UMediaServicesProfile |
Call Timeout |
Specifies the time (in milliseconds) that Telephony Server waits to configure resources for this application. |
Valid Values: A string of digits Default Value: 5000 |