All keys
This guide contains all possible configuration keys which can be supplied via the query string of the gadget URL provided in the Live Activity Configuration
While providing configuration via the query string in a URL is not convenient and error prone, it is the only possible solution at the present time.
URL encoding
In order to shorten the trial and error phase, please refer to RFC 3986 for detailed information about valid characters.
While different browsers may not follow this standard, it is good practice to encode the following characters:
| Character | Encoding |
|---|---|
! | %21 |
$ | %24 |
& | %26 |
' | %27 |
( | %28 |
) | %29 |
* | %2A |
+ | %2B |
, | %2C |
; | %3B |
= | %3D |
Minimal configuration
In order to use b+s Connects for SAP C4C, at least the following configuration keys must be provided:
finUrlA.finHttpPortAif other than 443.finXmppPortAif other than 7443.
Important notes
Changes to the following configuration keys will cause the widget to discard the locally saved configuration:
- finBoshRetries
- finBoshTimeout
- finConnectionTimeout
- finHttpPortA
- finHttpPortB
- finInternalNumberRegex
- finMaxConnectionRetries
- finMobileAgentChecked
- finMobileAgentMode
- finMobileAgentModeSelected
- finPollIntervalOnError
- finTransferDisabled
- finUrlA
- finUrlB
- finXmppPortA
- finXmppPortB
- finSsoFramePath
- ssRealTimeQueueViewEnabled
- ssRealTimeTeamViewEnabled
- ssEnableTeamViewSearchAndDial
- ssRealTimeSupervisorTeamViewEnabled
Changing these configuration keys will require agents to login again upon the next page reload.
List of configuration keys
finBoshRetries
Networks may drop and connections may be temporarily unavailable. This setting defines the number of ongoing failed BOSH XHR requests before the application considers the connection to have failed.
Default value
2
Example
&finBoshRetries=4
finBoshTimeout
Defines the number of seconds to wait for an XMPP Notification Event from Finesse. After the configured number of seconds, the XHR request is cancelled and a new one is initiated.
Default value
60
Example
&finBoshTimeout=100
Values less than 60 or greater than 120 are reset to the default value of 60.
finConnectionTimeout
The maximum number of seconds permitted for a connection attempt to one Finesse server.
Default value
20
Example
&finConnectionTimeout=40
finEnablePhoneBook
Enable Directory Lookup in Finesse Phone Books.
Default value
false
Example
&finEnablePhoneBook=true
Requires Finesse 12.5 or higher
finShowDetailedPhoneBooks
Enable the detailed view for the Finesse Phone Books. This will display the contact name, phone number, team name and description without hovering over the phone icon.
Default value
false
Example
&finShowDetailedPhoneBooks=true
Requires finEnablePhoneBook to be enabled
finHttpPortA
The port on which the Finesse Server Rest API (Side A) is listening.
Default value
443
Example
&finHttpPortA=1234
finHttpPortB
The port on which the Finesse Server Rest API (Side B) is listening.
Default value
443
Example
&finHttpPortB=1234
finMaxConnectionRetries
Defines the maximum number of connection attempts to the Finesse server before trying to connect to the secondary Finesse server.
Default value
2
Example
&finMaxConnectionRetries=4
finMobileAgentChecked
Defines a default value for the "Sign in as a Mobile Agent" checkbox on the login mask.
See Mobile Agent.
Default value
false
Example
&finMobileAgentChecked=true
finMobileAgentMode
Defines the overall mobile agent mode.
See Mobile Agent mode.
Default value
1
Example
&finMobileAgentMode=0
finMobileAgentModeSelected
Defines the mobile agent mode used as the default value on the login mask.
See Mobile Agent mode.
Default value
2
Example
&finMobileAgentModeSelected=3
finPollIntervalOnError
If the connection to Finesse is lost, this setting defines the interval (in seconds) before attempting to re-establish the connection. This procedure repeats until one of the servers (in redundant deployments) can be successfully connected.
Default value
10
Example
&finPollIntervalOnError=20
finTransferDisabled
Boolean to indicate if agents are allowed to transfer calls. If set to true (default), the UI controls for initiating consultation calls, conferences or direct transfers are not available.
Default value
true
Example
&finTransferDisabled=false
finUrlA
The URL of the Finesse server (Side A). This is a required configuration value. Please note: Do not add the port at the end of the URL since this is done via a separate configuration key finHttpPortA.
Default value
Not set (empty string).
Example
&finUrlA=https://myFinesseServerA.myDomain
finUrlB
The URL of the Finesse server (Side B). This is an optional configuration value. Please note: Do not add the port at the end of the URL since this is done via a separate configuration key finHttpPortB.
Default value
Not set (empty string).
Example
&finUrlB=https://myFinesseServerB.myDomain
finXmppPortA
The Port on which the Finesse Notification Service (Side A) is listening.
Default value
7443
Example
&finXmppPortA=1234
finXmppPortB
The port on which the Finesse Notification Service (Side B) is listening.
Default value
7443
Example
&finXmppPortB=1234
finInternalNumberRegex
Use this configuration key to define the format for internal numbers. There will be no search triggered and no activity written for internal numbers. Leave this empty if internal numbers should not be handled separately.
Examples:
^\+123456if internal number starts with +123456^\d{4,6}$if internal numbers are 4 to 6 digits long
Default value
Not set (empty string).
Example
&finInternalNumberRegex=^\d{4,6}$
mainColor
The color to use as main color for the user interface.
Colors are configured as HEX values without the leading hash character #.
See User Interface
Default value
354a5f
Example
&mainColor=0a6ed1
secondaryColor
The color to use as secondary color for the user interface.
Colors are configured as HEX values without the leading hash character #.
See User Interface
Default value
0a6ed1
Example
&mainColor=354a5f
snColorTheme
The color theme to use on the user interface. Valid values are light and dark.
See User Interface.
Default value
light
Example
&snColorTheme=dark
snEnableNotifications
Display browser notifications on incoming workitems or agent state changes initiated by the server.
If set to true, agents need to open the gadget in a separate browser window in order to give permission to the application for displaying notifications. This permission cannot be granted when loaded in an iframe.
Default value
false
Example
&snEnableNotifications=true
spActivityFieldMap
Apply context parameters for incoming calls to the Live Activity.
See Live Activity.
Default value
No rule configured.
Example
&spActivityFieldMap={"termination":"Custom_1"}
ssCallDataConfiguration
Defines which information from Cisco will be shown to the agent when receiving a routed call.
Default value
No mapping configured.
Example
&ssCallDataConfiguration={"Language":"callVariable1","TicketNr:":"callVariable2"}
ssCtDRegex
Phone number translation rules that are applied when using Click-to-Dial.
See Phone Number Translations.
Default value
No rule configured.
Example
&ssCtDRegex={"Remove all but digits and plus":"[1,17]->[^%2B\\d]%2B"}
ssLookupRegex
Phone number translation rules that are applied to the ANI before creating an activity in the live activity center of SAP C4C.
See Phone Number Translations.
Default value
No rule configured.
Example
&ssLookupRegex={"Remove all but digits and plus":"[1,17]->[^%2B\\d]%2B"}
ssRealTimeQueueViewEnabled
Enable or disable the Real Time Queue View for agents.
This view is not available on UCCX deployments.
Queue statistic updates need to be enabled on the Finesse Server.
See Real Time Views.
Default value
true
Example
&ssRealTimeQueueViewEnabled=false
ssRealTimeTeamViewEnabled
Enable or disable the Real Time Team View for agents.
See Real Time Views.
Default value
true
Example
&ssRealTimeTeamViewEnabled=false
ssEnableTeamViewSearchAndDial
Enable or disable the search field for agents.
See Real Time Views.
Default value
false
Example
&ssEnableTeamViewSearchAndDial=true
ssRealTimeSupervisorTeamViewEnabled
Enable or disable the Real Time Supervisor View for supervisors.
See Real Time Views.
Default value
true
Example
&ssRealTimeTeamViewEnabled=false
ssTimeInStateBarEnabled
Enable or disable timers indicating how long an agent is in a given agent state (Ready or Not Ready).
Default value
true
Example
&ssTimeInStateBarEnabled=false
ssEnableSilentMonitoringIndicator
Enable or disable the indicator on the agent's view when a supervisor is monitoring the call.
Default value
true
Example
&ssEnableSilentMonitoringIndicator=false
ssDefaultWarningThreshold
Default warning threshold for number of items in a queue.
These thresholds are only available if the Queue view is enabled.
The warning threshold has to be lower than or equal to the critical threshold. Leave blank or set to 0 to disable this threshold.
See Queue Threshold Bar.
Default value
0
Example
&ssDefaultWarningThreshold=2
ssDefaultCriticalThreshold
Default critical threshold for number of items in a queue.
These thresholds are only available if the Queue view is enabled. Leave blank or set to 0 to disable this threshold.
See Queue Threshold Bar.
Default value
0
Example
&ssDefaultCriticalThreshold=3
ssOverrideWarningThreshold
With this setting it is possible to override the default warning threshold for matching queues. The first entry is the name that has to match and the second the value to override.
See Queue Threshold Bar.
Default value
Not set (empty string).
Example
&ssOverrideWarningThreshold={"EMAIL_QUEUE_1":"2", "VOICE": "4"}
ssOverrideCriticalThreshold
With this setting it is possible to override the default critical threshold for matching queues. The first entry is the name that has to match and the second the value to override.
See Queue Threshold Bar.
Default value
Not set (empty string).
Example
&ssOverrideCriticalThreshold={"EMAIL_QUEUE_1":"3", "VOICE": "8"}
ssDisableDirectTransfer
This setting allows the direct transfer option to be disabled.
See Direct Transfer.
Default value
false
Example
&ssDisableDirectTransfer=true
ssDefaultView
Sets the default view of the gadget.
Possible values are:
home, teamView, queueView, supervisorView, teamMessages
Only navigates if the view is enabled.
Default value
home
Example
&ssDefaultView=queueView
finSsoFramePath
The path to the SSO frame file on the Cisco Finesse Server. Keep this blank if Single Sign-On is not used.
Default value
Not set (empty string).
Example
&finSsoFramePath=/3rdpartygadget/files/C4C/SSO/finesseSSOFrame.html