Configuration
This section provides you with instructions on how to configure Desktop Connect Express to integrate outbound and inbound calls with desktop applications and perform different actions based on the information provided in the PCAgent screen.
Also see:
- User interface configuration
- Rules
- Actions
- Data store integration
- Web service integration
- Extensions
Desktop Connect Express Configuration Settings File Overview
All the configuration settings for Desktop Connect Express are contained in the Desktop Connect Express Configuration Settings file which is located in the folder where Desktop Connect is installed. This file contains Sections and Parameters that are used to configure Desktop Connect Express.
Section headings are entered in square brackets “[“ and “]”. The Desktop Connect Express Configuration Settings contain the following section headings:
[GeoPDI]
[StartUp]
[Default]
[Terminate]
[PluginList]
[ExtensionList]
[RuleX] (where X is the rule number)
[GduTranslation]
[plugins]
[extensions]
Sections
Section Header |
Description |
---|---|
GeoPDI |
System wide parameters |
StartUp |
Defined Popup actions that are executed once, at startup |
Default |
Default information message, timer thresholds, integration type, automated action, and buttons (used on startup and when no other rule applies) |
Terminate |
Rule executed when the inbound or outbound call is terminated |
RuleX |
Up to 999 rules can be configured, each containing the rule definition, information message, timer thresholds, integration type, automated action, and buttons are configured which will be run if the rule is satisfied. |
GduTranslation |
Translation rules for data attached to call |
plugins |
Named configuration section, as listed in the PluginList section, containing plugin setting |
extensions |
Named configuration section as listed in Extension section, containing various third party assembly settings |
Parameters are entered as a parameter name with an “=” sign and then the parameter variable itself.
For example the default ConfigUrl parameter is the following:
ConfigUrl=http://desktopconnect.configuration.server:8080/GeoPDI/Config
Parameter list
Parameter | Section | Description | Values |
---|---|---|---|
ConfigURL |
GeoPDI |
When using TomCat web configuration, the URL of the TomCat web service must be entered |
http://{HostIP}:8080 /GeoPDI/Config |
ShowScreen |
GeoPDI |
Controls whether Desktop Connect Express window is displayed |
Y or N |
StayOnTop |
GeoPDI |
Controls whether Desktop Connect Express window stays on top if displayed |
Y or N |
PosX |
GeoPDI |
Stores the x co-ordinate of the last window location for next startup if displayed |
Last window location X co-ordinate |
PosY |
GeoPDI |
Stores the y co-ordinate of the last window location for next startup if displayed |
Last window location Y co-ordinate |
ShowInfo |
GeoPDI |
Controls whether Information window displayed. The information window is used to display messages and data provided by PCAgent. |
Y or N |
ShowTimer |
GeoPDI |
Controls whether call timer is displayed |
Y or N |
ShowInTaskbar |
GeoPDI |
Controls whether the Desktop Connect is displayed in the taskbar |
Y or N |
AllowMaximize | GeoPDI | Controls if the application allows users to use the application in maximized form state | Y or N |
Maximized | GeoPDI | Stores the application window state, for the next startup to display | Y or N |
MinHeight |
GeoPDI |
Controls the height of the Desktop Connect window if displayed. |
1-3 |
WebPlugin |
GeoPDI |
Not required for PCAgent Integration - Only required for http requests Enables or disables the web plugin. Default value is N |
Y or N |
WebPluginPort |
GeoPDI |
Not required for PCAgent Integration - Only required for http requests The number of the Web Plugin listener port. Web Plugin will listen to web requests bound to IP 127.0.0.1 and the configured port. |
TCPIP Port Number. Default value is 8072 |
WebPluginPath |
GeoPDI |
Not required for PCAgent Integration - Only required for http requests The path of the html or js files that may be used through the Web Plugin.). |
Web Plugin path. The default value is ..\h</p> (relative to the Desktop Connect Express application path |
APCEnabled |
GeoPDI |
Parameter to turn on or off event handling from APC. |
Y or N |
InbEnabled |
GeoPDI |
Parameter to turn on or off event handling from AES server, inbound call handling |
Y or N |
RegisterTransfer | GeoPDI | Parameter controlling to trigger a rule upon transfer event (e.g. consultation transfer passes the original CTI information upon transfer event) | Y or N |
AAgentID |
GeoPDI |
Agent ID for the acquire skill (requires Geomant Blend Skill Web service) |
Valid agent ID |
ASkill |
GeoPDI |
Skill for the acquire skill (requires Geomant Blend Skill Web service) |
Valid skill |
ASkillLevel |
GeoPDI |
Skill level for the acquire skill (requires Geomant Blend Skill Web service) |
1-16 |
ASkillURL |
GeoPDI |
URL of the web service for the acquire skill (requires Geomant Blend Skill Web service) |
http://{HostIP}:8080 /smswsc/ |
Extension |
GeoPDI |
Extension of the phone set, where the agent is sitting, this extension is service observed and all inbound call event information are forwarded. |
Valid phone extension |
TLink |
GeoPDI |
A valid CSTA protocol telephony link, used for communication with the Avaya Application Enablement Services |
AVAYA#{CM host name}#CSTA#{AES host name} |
TUser |
GeoPDI |
A CT enabled AES user |
User name |
TPassword |
GeoPDI |
The password of the CT user |
User password |
SecondaryTLink |
GeoPDI |
A valid CSTA protocol telephony link, used as a fallback option for communication with the Avaya Application Enablement Services |
|
SecondaryTUser |
GeoPDI |
A CT enabled AES user |
|
SecondaryTPassword |
GeoPDI |
The password of the CT user |
|
UUIStructure |
GeoPDI |
Field data names |
Eg. SCREENPOP|ACCOUNT |
UUISeparator |
GeoPDI |
UUI data field separator |
Eg. | |
CollectVDN |
GeoPDI |
Comma separated list of VDN collecting digits in the vector step |
Valid VDN extension 552111;552112 |
FilterVDN |
GeoPDI |
If set the application receives only the Queued and Diverted events from the CTI server |
Y or N |
ShowPlugin |
GeoPDI |
Defines whether to show the plugin section on the Desktop Connect Express GUI |
Y or N |
PluginWidth |
GeoPDI |
Controls the width of the plugin section |
Integer value |
PluginHeight |
GeoPDI |
Controls the height of the plugin section |
Integer value |
UICulture |
GeoPDI |
Controls the GUI language, currently English and Hungarian is supported |
en-GB or hu-HU |
SaveExtension |
GeoPDI |
Controls whether to save the entered extension or always ask to enter upon startup |
Y or N |
GduPlugin |
GeoPDI |
Enables or disables the Call Detail panel |
Y or N |
GduUrl |
GeoPDI |
The URL of the Call Detail web service |
Valid URL |
GduId |
GeoPDI |
The identifier of the call attached data, UCID, UUI |
e.g. <UCID> <UUI> |
GduWidth |
GeoPDI |
Controls the width in pixels of the Call attached data box, if omitted the default of 302 pixels is used |
Size e.g. 400 |
UseDataStore |
GeoPDI |
Controls whether to use the high available GeoDataStore over JSON protocol or the legacy GeoCCI storage |
Y or N |
RecorderEnabled |
GeoPDI |
Defines if the Verint integration module is active |
Y or N |
VerintPrimaryIntegrationServer |
GeoPDI |
Verint call recorder primary integration server address |
valid IP address or DNS name |
VerintPrimaryIntegrationPort |
GeoPDI |
Verint call recorder primary integration server port |
valid port e.g 3020 |
VerintSecondaryIntegrationServer |
GeoPDI |
Verint call recorder secondary integration server address |
valid IP address or DNS name |
VerintSecondaryIntegrationPort |
GeoPDI |
Verint call recorder secondary integration server port |
valid port e.g 3020 |
VerintApplicationServer |
GeoPDI |
Verint call recorder application server address |
valid IP address or DNS name |
Enabled |
Notification |
Defines if the toaster popup is enabled for alerting calls |
Y or N |
Icon |
Notification |
Image to display on the toaster popup |
Empty or valid path to the image |
Delay |
Notification |
Time in milliseconds the window is displayed. |
e.g. 3000 |
AnimationInterval |
Notification |
Interval in milliseconds used to draw the animation. |
e.g. 10 |
AnimationDuration |
Notification |
Time in milliseconds needed to make the window appear or disappear. |
e.g. 1000 |
Scroll |
Notification |
Whether to scroll the window or only fade it. |
Y or N |
IconPadding |
Notification |
Padding of icon image. |
e.g. 10 |
ButtonNameX |
Rule |
Button name where X is the button number within the header |
Text |
ButtonTypeX |
Rule |
The button type
|
DEBUG TOGGLE SENDKEY URL EXECUTE DDE RULE |
ButtonApplicationX |
Rule |
The unique title of the target application. This can be the full title, part of the title or the URL when using URL Type |
Text |
ButtonActionX |
Rule |
Action assigned to the button |
See Action Section page |
ButtonPropertyX |
Rule |
Controls the button enablement if not specified the button action can be executed every time it is clicked |
SingleClick – The button can be clicked only once for an incoming event. |
ButtonExtensionX |
Rule |
Extension name to execute when the button is pushed |
Extension listed under the [ExtensionList] section |
InfoMessage |
Rule |
Information message displayed in the information window |
Text |
NotificationMessage |
Rule |
Information message displayed in the toaster popup window |
Text |
Clipboard |
Rule |
The information in this field is copied to the clipboard when the rule is executed |
Text |
FieldX |
Rule |
The PCAgent match field where X is the field number |
PCAgent Field Name (Defined in the PC4.x calling list) |
ValueX |
Rule |
The match data to be compared within the field |
Text |
Threshold1 |
Rule |
First threshold in call duration timer to switch display to yellow |
Number of seconds |
Threshold2 |
Rule |
Second threshold in call duration timer to switch display to red |
Number of seconds |
Threshold3 |
Rule |
Third threshold in call duration timer to switch display to flashing red |
Number of seconds |
ResetAfter |
Rule |
Controls whether counter is reset on each call |
Y or N |
ExtensionX |
Rule |
Extension name to execute when the rule is activated |
Extension listed under the [ExtensionList] section |
PopUpTypeX |
Rule |
Automated Action Type where X is the unique number within the rule |
DDE SENDKEY EXECUTE DDE |
PopupWaitX |
Rule |
Wait time before executing action where X is the unique number within the rule. |
Seconds |
PopupApplicationX |
Rule |
The unique title of the target application. This can be the full title, part of the title or the URL when using URL Type. X is the unique number within the rule |
Text |
PopupFrontX |
Rule |
Controls whether PCAgent stays in front after automated action performed |
Y or N |
PopupBehaviorX |
Rule |
Controls how the IE browser acts when an URL action is triggered, possible values are NEW, NEWSESSION, TAB, EXISTING.
|
NEW – open URL in a new IE browser instance NEWSESSION – open URL in a new IE browser session TAB – open URL in a new IE tab instace EXISTING – open the URL in the same IE window |
AssemblyFileName |
plugins |
Assembly location of the plugin |
valid path (absolute or relative) |
PluginType |
plugins |
Type of the loaded assembly |
valid type |
AssemblyFileName |
extensions |
Assembly location of the plugin |
valid path (absolute or relative) |
PluginType |
extensions |
Type of the loaded assembly |
valid type (namespace.class) |
Rule section settings are applicable for Startup and Default sections
*
*
Desktop Connect Express sample configuration
[GeoPDI]
APCAgentPath = "C:\Program Files\Avaya\Proactive Contact 5.1\Agent\"
APCTitle=Proactive Contact Agent
APCAgentStartTimeout=10
APCEnabled = Y
InbEnabled=Y
ShowScreen=y
StayOnTop=Y
ShowInfo=Y
UICulture=en-GB
ShowTimer=Y
AllowMaximize = N
MinHeight=5
Transparency=200
WebPlugin=N
WebPluginPort=8072
PosX=1090
PosY=169
TLink = AVAYA#CM#CSTA#HUBIVSR83
TUser = tman
TPassword = tmanpassword
SecondaryTLink = AVAYA#MBT#CSTA#AESADVTSAPI
SecondaryTUser = tman
SecondaryTPassword = tmanpassword
SaveExtension = N
Extension=
[Notification]
Enabled = N
#Icon = D:\Development\Desktop Connect for MS CRM\Dynamics 2013\source\extensions\chrome\geo48.png
Delay = 3000
AnimationInterval = 10
AnimationDuration = 1000
Scroll = Y
IconPadding = 10
[ExtensionList]
PopAndClose = PopAndCloseExtension
[PopAndCloseExtension]
AssemblyFileName = D:\Development\DesktopConnect Xpress\sample\PopAndClose\PopAndClose\bin\Debug\PopAndClose.dll
#Namespace.Class
ExtensionType = PopAndClose.PopAndClose
[StartUp]
//not defined
[Default]
InfoMessage=Incoming call <ANI>
NotificationMessage = <ANI>
Extension1 = PopAndCloseExtension
[Terminate]
Extension1 = PopAndCloseExtension
[Rule1]
Field1 = <SIMONSAYS>
Value1 = Pop
InfoMessage = Action to do: <SIMONSAYS>
PopupType1=URL
PopupWait1=100
PopupApplication1=https://na12.salesforce.com
PopupAction1=https://na12.salesforce.com/<SID>
PopupFront1=y
[Rule2]
Field1 = <SIMONSAYS>
Value1 = Refresh
InfoMessage = Action to do: <SIMONSAYS>
PopupType1=URL
PopupWait1=100
PopupApplication1=https://eu2.salesforce.com
PopupAction1=https://eu2.salesforce.com/
PopupFront1=y