Configuration File Reference

The Connector’s settings are in CiscoUCCEConnectorService.exe.config, in the installation folder. The app settings are <add key="…" value="…" /> entries in its <appSettings> section. Restart the QMS Cisco UCCE Connector Service after editing the file; only the trigger rules configured in QMS take effect without a restart.

The Installed value column gives the value in the configuration a new installation gets. An upgrade keeps the existing file, so a setting added in a later release is absent from it and takes its default, given in the description.

CTI server and session

Setting Installed value Description

Setting	Installed value	Description
`CTIServer.IP-Address`	The address entered during setup	One or two comma-delimited addresses, each an IP address or a host name, optionally followed by `:port`. See Connecting to the CTI server.
`CiscoUCCEConnectorService.ConnectorKind`	`UCCX`	`UCCX` or `UCCE`. Absent or unrecognized: UCCE. See Supported Products.
`CiscoUCCEConnectorService.CtiProtocolVersion`	`16`	The CTI protocol version requested. Absent: 16 for UCCX, 19 for UCCE. See CTI Session Settings.
`CiscoUCCEConnectorService.FloatingHeaderTwoByte`	`false`	Leave `false`.
`CiscoUCCEConnectorService.CtiClientID`	empty	The CTI client ID, if the CTI server authenticates clients. Absent: empty.
`CiscoUCCEConnectorService.CtiClientPassword`	empty	The CTI client password, if the CTI server authenticates clients. Absent: empty.
`CiscoUCCEConnectorService.CtiHeartbeatIntervalSeconds`	`15`	Seconds between heartbeats once the session is open: 5 to 29, or 0 for none. Absent: 15. See Checking the session: heartbeats.
`CiscoUCCEConnectorService.CtiClientMode`	`Normal`	Leave `Normal`.
`CiscoUCCEConnectorService.LastConnectedCtiServer`	`A`	Written by the Connector: the CTI server it last connected to, `A` or `B`, which it tries first at startup.

CTIServer.IP-Address

The address entered during setup

One or two comma-delimited addresses, each an IP address or a host name, optionally followed by :port. See Connecting to the CTI server.

CiscoUCCEConnectorService.ConnectorKind

UCCX

UCCX or UCCE. Absent or unrecognized: UCCE. See Supported Products.

CiscoUCCEConnectorService.CtiProtocolVersion

16

The CTI protocol version requested. Absent: 16 for UCCX, 19 for UCCE. See CTI Session Settings.

CiscoUCCEConnectorService.FloatingHeaderTwoByte

false

Leave false.

CiscoUCCEConnectorService.CtiClientID

empty

The CTI client ID, if the CTI server authenticates clients. Absent: empty.

CiscoUCCEConnectorService.CtiClientPassword

empty

The CTI client password, if the CTI server authenticates clients. Absent: empty.

CiscoUCCEConnectorService.CtiHeartbeatIntervalSeconds

15

Seconds between heartbeats once the session is open: 5 to 29, or 0 for none. Absent: 15. See Checking the session: heartbeats.

CiscoUCCEConnectorService.CtiClientMode

Normal

Leave Normal.

CiscoUCCEConnectorService.LastConnectedCtiServer

A

Written by the Connector: the CTI server it last connected to, A or B, which it tries first at startup.

Operation

Setting Installed value Description

Setting	Installed value	Description
`CiscoUCCEConnectorService.ConnectorMode`	`Normal`	`Log`, `AgentState`, `TagRecordings` or `Normal`. Absent: `Normal`. An upgrade keeps the existing value; earlier releases installed `TagRecordings`. See Modes of Operation and Logging.
`CiscoUCCEConnectorService.ConnectorConfigPollIntervalSeconds`	`15`	How often, in seconds, the Connector checks QMS for changed trigger rules or product: 5 to 300, or 0 to disable. Absent: 15. See The configuration poll.
`CiscoUCCEConnectorService.UpdateQMSDataIntervalMinutes`	`5`	How often, in minutes, the Connector re-reads users and system flags from the Recording Services; 0 disables it. Absent: 5. See Other App Settings.
`CiscoUCCEConnectorService.FlagTrigger`	empty	Trigger rules in the configuration file, used only while QMS has none. See Mapping events to trigger flags.
`CiscoUCCEConnectorService.EventToUserMap`	not set	How events are mapped to QMS users. Absent or empty: the product’s default rules. See Mapping events to users.
`CiscoUCCEConnectorService.EmployUserSubset`	`false`	`true` limits event processing to the extensions in `UserSubsetExtensionList`.
`CiscoUCCEConnectorService.UserSubsetExtensionList`	empty	A comma-delimited list of extensions, used with `EmployUserSubset`.

CiscoUCCEConnectorService.ConnectorMode

Normal

Log, AgentState, TagRecordings or Normal. Absent: Normal. An upgrade keeps the existing value; earlier releases installed TagRecordings. See Modes of Operation and Logging.

CiscoUCCEConnectorService.ConnectorConfigPollIntervalSeconds

15

How often, in seconds, the Connector checks QMS for changed trigger rules or product: 5 to 300, or 0 to disable. Absent: 15. See The configuration poll.

CiscoUCCEConnectorService.UpdateQMSDataIntervalMinutes

5

How often, in minutes, the Connector re-reads users and system flags from the Recording Services; 0 disables it. Absent: 5. See Other App Settings.

CiscoUCCEConnectorService.FlagTrigger

empty

Trigger rules in the configuration file, used only while QMS has none. See Mapping events to trigger flags.

CiscoUCCEConnectorService.EventToUserMap

not set

How events are mapped to QMS users. Absent or empty: the product’s default rules. See Mapping events to users.

CiscoUCCEConnectorService.EmployUserSubset

false

true limits event processing to the extensions in UserSubsetExtensionList.

CiscoUCCEConnectorService.UserSubsetExtensionList

empty

A comma-delimited list of extensions, used with EmployUserSubset.

Logging

Setting Installed value Description

Setting	Installed value	Description
`Log.FileLogLevel`	`Info`	The level of detail in the log: `Debug`, `Info`, `Warn`, `Error`, `Fatal` or `None`. `Debug` logs every CTI message; `Info` logs much less. Absent: `Debug`.
`Log.RolloverInterval`	`Daily`	When to start a new log file: `Daily` or `Hourly` (`Minutely` for testing). Absent: `Daily`. See Logging.
`Log.MaxLogDays`	`30`	Log files older than this many days are deleted; `0` turns the clean-up off. Absent: 30.
`Log.ArchiveLogDays`	`7`	Log files older than this many days are zipped into the log folder’s `archive` subfolder; `0` turns archiving off. Absent: 7.
`CiscoUCCEConnectorService.LogMsgHexOnCapture`	`false`	`true` logs each CTI message as hex on receipt.
`CiscoUCCEConnectorService.LogMsgHexOnProcessing`	`false`	`true` logs each CTI message as hex as it is processed.
`CiscoUCCEConnectorService.ShallowMsgLogging`	`false`	`true`, in Log mode only, logs message headers without parsing the messages.

Log.FileLogLevel

Info

The level of detail in the log: Debug, Info, Warn, Error, Fatal or None. Debug logs every CTI message; Info logs much less. Absent: Debug.

Log.RolloverInterval

Daily

When to start a new log file: Daily or Hourly (Minutely for testing). Absent: Daily. See Logging.

Log.MaxLogDays

30

Log files older than this many days are deleted; 0 turns the clean-up off. Absent: 30.

Log.ArchiveLogDays

7

Log files older than this many days are zipped into the log folder’s archive subfolder; 0 turns archiving off. Absent: 7.

CiscoUCCEConnectorService.LogMsgHexOnCapture

false

true logs each CTI message as hex on receipt.

CiscoUCCEConnectorService.LogMsgHexOnProcessing

false

true logs each CTI message as hex as it is processed.

CiscoUCCEConnectorService.ShallowMsgLogging

false

true, in Log mode only, logs message headers without parsing the messages.

Recording Service endpoints

The <system.serviceModel> section’s <client> element holds one endpoint for each QMS server running a Call Recording Service, named WSHttpBinding_IRecordingControlService_<server> with the address http://<server>:8010/. The Configuration Tool maintains them from its list of QMS Recording Servers; editing them by hand is not needed. Every endpoint uses the one binding, RecordingControlServiceBinding.

A configuration from an earlier release, which an upgrade keeps, also holds an endpoint named WSHttpBinding_IRecordingControlService at the same address as the first, so that every request reached the same Recording Service twice. The Connector now skips an endpoint whose address another endpoint already has, and logs a warning naming it; the Configuration Tool removes it the next time it saves.