CTI32 Engine Class Library

ConfigData Members

ConfigData overview

Public Instance Constructors

ConfigData Constructor Initializes a new instance of the ConfigData class.

Public Instance Fields

analogRingCount Sets the ring count value for analog lines. Valid values are from 1 to 15. If lookForAnalogCallerId is set to true, Valid values are from 2 to 15.
autoAnswerIncomingCall Whether to have the engine automatically go OFFHOOK on a new call. true / false - recommend true.
boardData Board information for the entire system.
channelData Channel information for the entire system.
ctiLogName Name of the log file name for the lower level CTI32.log
ctiLogOption Options for the CTI32.log 0 - No Logs 1 - Main log file only and print on console 2 - Create log file for each channel AND a main log file (do not print on console) 3 - Create log file for each channel AND a main log file (also print on console) 4 - Create log file for each channel No main log file (do not print on console) 5 - Create log file for each channel No main log file (print on console) 11 - Main log only and don't print on console Recommend 11
databaseConnectString The ODBC or SQL connect string. Leave this empty if you do not need to use CTI32 database access.
dbConnection Database class
defaultDLL The name of the DLL your code will call on an incoming call. You can redirect to a different DLL by using the DnisMethod in this defaultDLL.
defaultMethod The method to call on an incoming call if you do not redirect using the DnisMethod
defaultType Namespace.Class of the DLL you are calling
delayAfterAnswer How many milliseconds to delay right after the engine answers the phone on an incoming call. Sometimes the audio is not immediately available and so you may need to pause. 1000 = 1 second
dialMask DialMask information
dialMethod Used for ISDN implementations. Sets various templates for the ISDN call structure. Current values are T1, E1, AVAYA, SDN, NI2
dispatchDLL A dispatch DLL is a user thread where you may implement any logic that you want. Usually used for initiating outbound calls. This parameter specifies the DLL where you have implemented the Dispatch logic. Leave blank if you have not impemented a dispatch thread.
dispatchMethod The method in dispatchDLL where your user logic is implemented.
dispatchStopMethod Method in dispatchDLL the engine should call on shutdown.
dispatchType Namespace.Class (type)
dispatchUserQueue A remote client application can send in a user function passing up to 5 parameters The command is put in this Queue for the Dispatch thread to act on
dnisExtDLL An External DNIS DLL. This allows you to have a separate DLL for handling DNIS Lookups.
dnisExtMethod An External DNIS Method. This allows you to have a separate DLL for handling DNIS Lookups.
dnisExtType An External DNIS Type. This allows you to have a separate DLL for handling DNIS Lookups.
dnisMethod The method in the defaultDLL that implements logic on which DLL/Method to call based on the number dialed (DNIS). Leave empty if you don't want to implement this method.
emailFrom The email address that will appear as FROM:.
emailServer Name of SMTP server to send messages to. Must accept relay from this computer. i.e. mail.yourserver.com
emailTo Who to send the message TO. i.e. you@yourserver.com. You can comma separate multiple desinations. i.e. you@yourserver.com,ron@myserver.com
eng Engine class. Use this to get at the methods in the Engine like LauchOutboundCall
faxPortsObsolete. Fax Port information. Obsolete. The Fax Ports are now maintained at the Cti32 level.
flashTime Number of milliseconds time ONHOOK during a flash. This sets the dialogic board level parameter DXBD_FLASHTM
globalCallProtocol The Global call protocol. i.e. SIP for HMP, DM3 for DM/V boards
lengthOfTouchTone 0=Dialogic default. How long to keep tone playing. If you are having problems, try 10 and adjust from there
log Log class
logDisable Set to true if you do not want logs
logFile Contains the path to the CTI32Engine log file
logLevel Level of logs that you want logged. Recommend 0 for this parameter.
logMaxSize The size in bytes of how large the log file can grow. When it reaches this size, the file is renamed to .bak and a new log file is created. The previous .bak file is deleted forever.
lookForAnalogCallerID Set to true if you have an analog board and your phone line has caller id feature. You also need to set the perfectCall parameter to 3 to enable caller id
msiBoardData MSI board information for the entire system
msiNumBoards Number of MSI boards in the entire system
msiNumPorts Number of MSI station in the entire system
msiPortData MSI station information for the entire system
nextFaxPort Next round robin fax port to use
numBoards Number of Dialogic boards in the system.
numDialMasks Number of Dial masks defined
numFaxPorts Number of Fax ports available in the system
numPorts Total number of channels in the system
origConfig The original XML document loaded from CTI32Engine.config
pauseBeforeExecution Time in seconds to wait before starting the Engine. This may be helpful for automated startup
pauseBetweenCallsMilliseconds In outbound scenarios, this will insure a subsequent call will not take place faster than the switch is ready for it after the previous hangup. 1000 = 1 second.
perfectCall PerfectCall is a bitmask of the following values: 1 = Perfect Call Enabled 2 = Analog Caller Id 4 = Enable Continuous Speech Recognition (CSP) 8 = Enable CSP but on a DM3 board. Combination Examples: 0 = No PerfectCall Call progress, No Analog Caller ID. 1 = Enable PerfectCall call progress only. 2 = Enable Analog Caller ID only. 3 = Enable both PerfectCall and Analog Caller ID.
sendStatsReport True to e-mail daily stats report at midnight. If set to true you must define the e-mail parameters.
serverIpPort IP Socket to listen on
serverLogin Login clients must use to attach
serverName Name of this computer. Recommend using localhost
serverNumPorts Maximum number of concurrent Tmonitors or client apps that can connect at once
serverPassword Password clients must use to attach
serverUserDefinedFields Estimated number of different name/value pairs your application will write to.
setChannelState For ISDN only. true or false. Whether to Set each ISDN channel to INSERVICE on startup. Setting this to true can cause some ISDN protocols to lock up.
statsSyncVar A variable for the stats thread to lock on
stopEngineOnCriticalFailure In the event of an ISDN DropCall failure - automatically shutdown the engine.
syncVar Global lock variable for synchronizations like locks
timeBetweenTouchTones 0=Dialogic default. Time delay between sending touch tones. If you are having problems try 5 and adjust from there.
useAutoConfiguration Automatically Configure System
useDllCache Causes The Service To Cache Dlls
useGlobalCall true/false. Use global call only when necessary. It is required for HMP and DM/V boards.
useQualificationTemplates For Call Progress try using this to improve accuracy of HUMAN / MACHINE. Pass the silence Threshold (i.e. 250)
useResourcePooling Use Resource Pooling
useSqlServer Use SQL Server connections rather than ODBC
vapFileName The VAP file is used when playing numbers, money, dates, times, etc. Specify the name of the VAP file (i.e. English.VAP)
vFormat Specify the voice format that your voice files are recorded in. You can then use this parameter in your cti.Play calls.
xmlFile Name of the xmlFile loaded, usually cti32engine.config

Public Instance Methods

Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

ConfigData Class | CTI32Engine Namespace