Skip to main content
Version: 4.2.0

Agent Adapter

[Core]-Section​

HttpServerPort​

Required: No

Default = 9080

Range = 1024-65535

Description = Port of the status HTTP web server. Data type: int.

HttpAllowedHosts​

Required: No

Default = Only localhost: “(127\.[\d.]+|[0:]+1|localhost)”

Range = Full: ".*"

Description = Regex rule to analyze ip-address

TelnetServerPort​

Required: No

Default = 9010

Range = 1024-65535"

Description = Port of the telnet remote console. Data type: int

TelnetAllowedHosts​

Required: No

default: Only localhost: “(127\.[\d.]+\|[0:]+1\| localhost)

Range: Full: “.*”

Description: Regex rule to analyze ip-address

LogMask​

Required: Yes

Defalult: 0x00040015

Range: 0x0-0xffffffff

Description: Defines the log mask Data type: int

CollectedLogMask​

Required: No

Default: 0xfffffff3

Range: 0x0-0xffffffff

Description: Defines the collected log mask, Data type: int

LogFile​

Required: No

Range: -

Default: C:\ProgramData\BucherSuter\logfiles\ConnectsHarmony\HarmonyAgentAdapter.log

Description: Path to the log file. Data type: String

MaxLogFileCount​

Required: No

Default: 10

Range: 1-200

Description: Max archived log files Data type: int

MaxLogFileSize​

Required: No

Default: 10000KB

Range: 1KB-500MB

Description: Max size of one log file, Data type: String (with unit KB, MB or GB)

[Gate_fin]-Section​

FinesseRedundancyMode​

Required: No

Default = Redundant

Range = Redundant, SingleNode

Description = Defines the type of the Finesse Server. If “Redundant” is specified, primary and secondary finesse configuration are required. Data type: String

XmppResource​

Required: Yes

Default: “”

Range: -

Description: Resource name to connect to Finesse

XmppConnectTimeoutInSeconds​

Required: No

Default: 75

Range: 5-100 [sec]

Description: For every agent a separate notification connection to Finesse must be established. This is supervised by this timeout value. Timeout should be as low as possible, but Finesse need some time to answer notification connetion requests, especially if a lot of agents are handled.

DefaultNotReadyReason​

Required: Yes

Default: “”

Range: -

Description -

DefaultLogoutReason​

Required: Yes

Default: “”

Range: -

Description: -

NotReadyReasonHidePrefix​

Required: Yes

Default: _

Range: String

Description: Configured not ready reasons in Finesse with this prefix are not displayed in agent status drop down list. E.g. suppress your default not ready code in dropdown: _DefaultAway!

DefaultNotReadyReasonSuffix​

Required: No

Default: !

Range: String

Description: Optional. Add this character to a not ready reason code in Finesse and it will used as default not ready reason just after logon. If no reason with suffix found, no NotReady reason is set after login.

RonaNotReadyReasonSuffix​

Required: Yes

Default: #

Range: String

Description: Add this character to a not ready reason code in Finesse and it will used as not ready reason for RONA. If no reason with suffix found, the first found not ready reason is used.

FeedbackWaiterLoginTimeoutInSeconds​

Required: No

Default: 75

Range: 5-100 [sec]

Description: Timeout waiting for logged-in event on XMPP channel after sending login request on REST channel.

EncryptXmppConnection​

Required: Yes

Default: false

Range: false, true

Description: XMPP Finesse port: 5222, Encrypted: 5223 Set to true, if XMPP encryption is enabled on Finesse server. For Finesse >= 12.5 XMPP encryption is enabled by default

[Gate_fin\PrimaryFinesseNode]-Section​

Host​

Required: Yes

Default “”

Range: Hostname and domain

Description: Hostname or IP Address of the primary Finesse node. Data type: String

Port​

Required: Yes

Default: 8445

Range: 1024-65535

Description: Communication Port of Finesse, Data type: ushort

IsSecure​

Required: Yes

Default: true

Range: false, true

Description: Enables/disables secured communication with Finesse, Data type: bool

[Gate_fin\SecondaryFinesseNode]-Section​

Host​

Required: Yes

Default “”

Range: Hostname and domain

Description: Hostname or IP Address of the secondary Finesse node. Data type: String

Port​

Required: Yes

Default: 8445

Range: 1024-65535

Description: Communication Port of Finesse, Data type: ushort

IsSecure​

Required: Yes

Default: true

Range: false, true

Description: Enables/disables secured communication with Finesse, Data type: bool

[Gate_fin\MediaRouting]-Section​

EmailDomain​

Required: Yes

Default: “”

Range 1-65535

Description: The ID of the MediaRoutingDomain used for Emails. Data type: number

ChatDomain​

Required: Yes

Default “”

Range: 1-65535

Description: The ID of the MediaRoutingDomain used for Chat. Data type: number

[Gate_fin\MediaReroute]-Section​

RoutingHostVarA​

Required: Yes

Default: pv9

Range: pv1-pv10 or ECC.user.xyz

Description: Defines the Peripheral- or ECC variable used to transport the hostname of RoutingAdapter A from QueueAdapter configuration through RoutingAdapter, UCCE and Finesse into AgentAdapter. This configuration value must match the RAHostVarA configuration value in QueueAdapter and will contain the value configured as HostnameA in QueueAdapter. The configured variable must be large enough to transport the fully qualified hostname as configured in QueueAdapter as HostnameA.

RoutingHostVarB​

Required: Yes

Default: pv10

Range pv1-pv10 or ECC.user.xyz

Description: Defines the Peripheral- or ECC variable used to transport the hostname of RoutingAdapter B from QueueAdapter configuration through RoutingAdapter, UCCE and Finesse into AgentAdapter. This configuration value must match the RAHostVarB configuration value in QueueAdapter and will contain the value configured as HostnameB in QueueAdapter. The configured variable must be large enough to transport the fully qualified hostname as configured in QueueAdapter as HostnameB. It is possible to configure the same variable for RoutingHostVarA and RoutingHostVarB. In that case, the variable will contain both host names A and B separated by a semicolon. The variable must then be large enough to contain both host names and the semicolon separator. If you only have one RoutingAdapter, you can set RoutingHostVarB also to the same value as RoutingHostVarA.

RonaTimeoutEmailInSeconds​

Required:No

Default: 30

Range 0–900 [sec]

Description: Defines the timeout until the agent should accept offered emails.

RonaTimeoutChatInSeconds​

Required: No

Default: 30

Range: 0–900 [sec]

Description: Defines the timeout until the agent should accept offered chats.

RoutingHostPort​

Required: Yes

Default: 8095

Range: TCP/IP port range

Description: Defines the port used to connect RoutingAdapter in case of RONA timeout or reject by agent to send a new route request. This port must match to the port configured in HarmonyRoutingAdapter setting [Gate_reroute] à ServerUri

RoutingHostHttps​

Required: Yes

Default: false

Range: false, true

Description: Defines if the new route request to RoutingAdapter in case of RONA timeout or reject by agent uses https encryption. When set to true, the ServerUri configured in HarmonyRoutingAdapter setting [Gate_reroute] à ServerUri must start with https://.

[Gate_harmony]-Section​

Host​

Required: No

Default: localhost

Range: -

Description: Hostname or IP Address used to connect to Harmony Integration Server.

Port​

Required: No

Default: 61616

Range: 1024-65535

Description: TCP port used to connect to Harmony Integration Server.

EnvironmentName​

Required: No

Default: dnbridgehost

Range: -

Description: The name of the environment as configured in Harmony Configuration Server.

RequestProcessingTimeout​

Required: No

Default: 20

Range: 5-100 [sec]

Description: This timeout controls how fast a response must be provided for an agent request. If queries to telephony or media providers take longer than specified value in "RequestProcessingTimeout" the agent gets an error message.

ShutdownDelayInSeconds​

Required: No

Default: 5

Range: 0–900 [sec]

Description: Delay in seconds before shutdown

SessionInitTimeoutInSeconds​

Required: No

Default: 75

Range: 0–900 [sec]

Description: Timeout for login in CCE

AgentPresenceActive​

Required: Yes

Default: true

Range: true, false

Description: True, if Agent Presence should be activated. See ConnectsForOracleServiceCloud_Memo_AgentRealTime_4-2-0_Rev1-0 for further information