ChatConnector

The configuration of ChatConnector is stored in the configuration-file (.ini). The installation program creates this file with the settings provided during setup. The configuration of ChatConnector can be adjusted by editing this configuration-file or by using the command line interface. The service must be restarted for the changes to take effect. If a setting is not found, the program’s default value is used.

Unless explicitly specified by a command line argument, the path to the .ini file is the name of the executable file with the .exe extension replaced by “ini” and the instance name used as suffix.

C:\ProgramData\BucherSuter\MCAforSAP\MultiChannelComponents\ChatConnector\McilChat_SAP1.ini

To view and manually configure ChatConnector it is necessary to edit the configuration-file. It is suggested to back up the original file before editing it. The configuration-file can be edited with any text editor like Notepad.

[Core]

AutoStartHttpServer

Default : 1

Range : 0,1

Description : Defines whether to start the HTTP server automatically at startup

AutoStartTelnetServer

Default : 1

Range : 0,1

Description : Defines whether to start the telnet server automatically at startup

ChatSessionHistoryMaxSize

Default : 50

Range : not available

Description : Maximal number of messages saved in a chat session history

HttpServerPort

Default : 9080

Range : not available

Description : Port to listen to for HTTP connections, used to display status page

LoggerConfigFile

Default : logger.config.xml

Range : not available

Description : Logger configuration file path, relative to CRMConnectorSAP executable file, value cannot be configured via remote console

GateId(n)

Default : empty

Range : not available

Description : List of connector gates to load, each GateId must have a corresponding GateType setting

GateType(n)

Default : empty

Range : not available

Description : list of gate types to load, each GateType must have a corresponding GateId setting

TelnetServerPort

Default : 9010

Range : not available

Description : Telnet (remote console) connections port

[Gate_mcil]

AllowedIdleTime

Default : 3600

Range : not available

Description : Max time for an idle chat

ApplicationId

Default : 33

Range : not available

Description : MediaManager application identifier: must be unique among all applications connecting to the MediaManager

MessageFailurePolicy/DropAllMessagesOnRetryFailed

Default : 1

Range : 0,1

Description : If a chat message could not be successfully transmitted to the MediaManager, this value determines if only the failed message is dropped or any other pending message as wells

HeartbeatInterval

Default : 5000

Range : not available

Description : Amount of time between two heartbeats, this value must be less than the MediaManager's maximal interval

LogMcilCommunications

Default : 1

Range : 0,1

Description : Turns MCIL communication logging on or off

LogMcilIgnoreHeartBeats

Default : 1

Range : 0,1

Description : If set to “1”, MCIL heartbeats are ignored when MCIL communications are logged

MmHostA

Default : localhost

Range : not avilable

Description : Hostname or IP address of MediaManager A host

MmHostB

Default : localhost

Range : not available

Description : Hostname or IP address of MediaManager B host

MmPortA

Default : 7050

Range : not available

Description : Remote port of MediaManager A

MmPortB

Default : 7050

Range : not available

Description : Remote port of MediaManager B

RequestTimeout

Default : 5000

Range : not available

Description : Maximum time in milliseconds for a request/response

MessageFailurePolicy/RetryTime

Default : 300000

Range : not available

Description : Amount of time allowed in milliseconds to retry to send a chat message when it failed

MaxRerouteCount

Default : 10

Range : not available

Description : Maximum number of reroutes

RunScriptParameterInName

Default : not available

Range : not available

Description : Specifies the variable used for the RunScript-node (incoming)

RunScriptParameterOutName

Default : not available

Range : not available

Description : Specifies the variable used for the RunScript-node (outgoing)

ChatBeingTransferedMessage

Default : "The chat session is being transferred to another agent. Please be patient."

Range : not available

Description : Message that will be displayed to the user if the chat session is transferred to another agent

ChatIdentifier

Default : chat://

Range : not available

Description : Chat identifier-prefix

ChatPartnerFound

Default : "You are now connected with an agent."

Range : not available

Description : Message that will be displayed if the customer is connected to an agent

InternalErrorMessage

Default : "Our servers are busy and your request could not be processed. We are sorry for the inconvenience. Please try again later."

Range : not available

Description : Message displayed to the user if an internal error occurs

LookingForChatPartnerMessage

Default : "We are currently looking for your chat partner."

Range : not available

Description : Message displayed to the user while the system is looking for an available agent

SessionClosedByAgentMessage

Default : "The agent closed this chat session."

Range : not available

Description : Message displayed to the user if the chat session was closed by the agent

SessionClosedBySystemMessage

Default : "The chat session was closed by the system."

Range : not available

Description : Message displayed to the user if the chat session was closed by the system

SessionClosedMessage

Default : “This chat session is closed.”

Range : not available

Description : Default message displayed to the user if the chat session was closed

SystemMessagePrefix

Default : \<SYSTEM\>

Range : not available

Description : Prefix for messages issued by the system

[Gate_jabber]

Compress

Default : 1

Range : 0,1

Description : If set, Jabber stream compression is used

JabberServerHostname

Default : empty

Range : not available

Description : Hostname or IP address of the Jabber server

JabberServerPort

Default : 5222

Range : not available

Description : Remote port of the Jabber server

[DnChatUsers]

Username(n)

Default : empty

Range : not available

Description : Username, must be unique across all gates

Password(n)

Default : empty

Range : not available

Description : Password of corresponding user (see also “Hide passwords” section below)

ScriptSelector(n)

Default : empty

Range : not available

Description : CCE/CCH ScriptSelector of corresponding user

Configuration Example

[core]
HttpServerPort=9080
TelnetServerPort=9010
AutoStartHttpServer=1
AutoStartTelnetServer=1

[Gate_mcil]
ApplicationId=33
MmHostA=192.168.10.17
MmPortA=7050
MmHostB=192.168.10.16
MmPortB=7050

[Gate_jabber]
JabberServerHostname=192.168.10.14
JabberServerPort=5222

[LOGGER]
[DnChatUsers]
Username(0)=Support
Password(0)=SupportPassword
Username(1)=Sales
Password(1)=SalesPassword
ScriptSelector(0)=support_chat
ScriptSelector(1)=sales_chat

Encrypt Chat Service User Passwords

The passwords for the DnChatUsers can be stored in plaintext in the ChatConnector’s configuration-file. To encrypt the passwords, use the IniFilePasswordEncryptor.exe tool that is copied into the installation directory of the ChatConnector during the installation process.