application note for configuration registry parameters for ... · windows registry structure for ip...

Subject: Application Note for Configuration Registry Parameters for Avaya IP Agent Release 7.0 Issue: 2.0

Date:

September 18, 2007

ABSTRACT

The purpose of this document is to provide reference information regarding certain registry settings managed by the Avaya IP Agent R7 application that are specifically used for user-specific configuration customization of the user interface. The documented trees lie win the HKEY_CURRENT_USER hive, and as such are specific to a single Windows account. Only the IP Endpoint configuration for IP Agent R7, which runs entirely in the Secure Desktop mode, is applicable to this document.

This document is in no sense a complete documentation of the IP Agent Registry. For instance none of the global system parame-ters set in the HKEY_LOCAL_MACHINE tree appear here.

The customer should not undertake to change any settings other than those documented here. Any custom configurations should be comprehensively tested before deploying into a mass production environment.

Subject: Application Note for Configuration Registry Parameters for Avaya IP Agent Release 7.0 Issue: 2.0

Date:

September 18, 2007

1. INTRODUCTION 1.1 PURPOSE

This document is designed to document certain Windows Registry Keys that specify and control end user functions at the IP Agent R7 IP endpoint desktop. It should be used in conjunction with the IP Agent Configuration Utility and the iClarity Administration Con-trols (iClarityAdmin.exe) tools, both of which are available and distributed with the IP Agent R7 product. The IP Agent Configuration Utility is directly accessible from the IP Agent user interface (Files | Configuration Utility). The iClarityAdmin.exe tool is initially dis-tributed as a .zip archive that can be found in the IP Agent Application Directory after running the IP Agent R7 installation.

We must emphasize immediately that this document is not designed to be, and cannot be, a complete documentation of the entire Windows Registry structure for IP Agent. Many registry entries are used internally by the IP Agent application, and also are used in conjunction with IP Agent application code and other parts of the Windows Operating system. Such entries are NOT documented here, and any such items as the customer may find when browsing the registry, for example with a tool like regedit.exe, should not be interfered with. It is extremely likely that behavior of the application and presentation of the user interface will be severely com-promised. Even though items might have innocuous looking names, it cannot be assumed that a single change, addition or deletion in any (undocumented) key will have the hoped-for effect.

1.2 SCOPE This document is not designed to be a primer on the Windows Registry. It is assumed that the reader and user of this document have a detailed knowledge of Windows Application structure generically, and of the interactions between applications and the Win-dows Registry specifically. Further, it is assumed that this information will be used to facilitate mass deployment of IP Agent to desktops through such standard means as Microsoft SMS.

This information may be used in conjunction with a custom transform of the standard Avaya MSI. IP Agent R7 has adopted MSI technology for installation and upgrade.

The information contained here should only be assumed applicable for IP Agent R7, for IP Endpoint configurations.

1.3 VERSION CONTROL Issue Date Changes

0.1 3/27/2007 First Draft 0.2 3/29/2007 Second Draft. Expands Column 3 of table in Section 3.2 and makes other small changes as re-

quested by team after seeing Issue 0.1 1.0 6/18/2007 Release Draft. Fixed MRs. 2.0 9/18/2007 Remove Avaya Proprietary markings.

Issue 2.0

Page 2

2. GENERAL INFORMATION.

2.1 PATH ITEMS REFERENCES In the registry tables, there will be path items (i.e. %WINDOWS%) which are either determined during installation or at application runtime. It is again emphasized strongly that customers should not change any of these references after they have been initialized by the application. The following table is for reference only, and is one example of information that must not be tampered with after the initial installation of IP Agent.

Path Item Path Item Description

%APP_DATA_PATH% The root directory under which the Avaya IP Agent user specific data folders will be located. Example: C:\Documents and Settings\[username]\Application Data\Avaya\Avaya IP Agent

%APP_DIRECTORY% The name of the path where the iClarity application files are stored. This must be in the same directory as the IP Agent application programs. Example: C:\Program Files\Avaya\Avaya IP Agent)

%BKUP_LOG_FILE_PATH% The directory in which the rotated log files for the various different components are stored. Example: C:\Documents and Settings\[username]\Application Data\Avaya\Avaya IP Agent \BackupLogs

%IM_HISTORY_PATH% The directory in which the instant messages html files will be stored. Example: C:\Documents and Settings\[username]\Application Data\Avaya\Avaya IP Agent \Instant Message History

%GREETINGS_PATH% The directory in which the agent greeting audio files and agent greetings table file is stored. Example: C:\Documents and Settings\[username]\Application Data\Avaya\Avaya IP Agent

%LOG_FILE_PATH% The directory in which the log files for the various different components are stored. The service provider components require their initializing files (common.ini and definity.ini be located in this directory as well.) Example: C:\Documents and Settings\[username]\Application Data\Avaya\Avaya IP Agent \Log Files

%USERPROFILE% The directory in which the user files are generally stored by Windows applications. This directory is important for the Secured Desktop configuration. Example: C:\Documents and Settings\[username]\Application Data

Issue 2.0

Page 3

Path Item Path Item Description %WINDOWS% The directory in which the Windows operating system was installed.

Example: C:\Windows

%WINDOWS_SYSTEM% The directory SYSTEM that falls under the %WINDOWS% directory. Example: C:\Windows\System

% COMMON_APPDATA% The directory where common shared user data are generally stored by Windows applications. Example: C:\Documents and Settings\All Users\Application Data

2.2 PRIMARY ROOT REGISTRY KEYS DESCRIPTIONS The Avaya IP Agent application and components use Windows Registry key entries for storing configuration information. For each major key, it is stated whether information is contained in this document relevant to it. In cases where it is not, the customer is ad-vised once again that such data should not be tampered with.

Here is a general strong recommendation.

1) Do not change/add/delete anything in the HKEY_LOCAL_MACHINE hive.

2) Only change/add/delete items that are in the HKEY_CURRENT_USER hive, and then only if a) they are documented here and b) a complete configuration has been tested before deploying to a large end user population.

For reference and for assistance in navigating to relevant nodes in the registry, the application root registry keys are as follows:

HKEY_LOCAL_MACHINE\Software\Avaya\Avaya IP Agent

This root key includes the system level configuration information of Avaya IP Agent. It is strongly advised that customers not tamper with information in this registry hive and sub-hives. Almost all these keys are set by the IP Agent Installer and are used by the system level software.

HKEY_CURRENT_USER\Software\Avaya\Avaya IP Agent

This is one of two root keys that provide most of the end-user specific configuration parameters. Most of the IP Agent End User configuration specifics, after the initial registration and login to Communication Manager, are found in this hive. It is believed that customers will find two sub-hives Config\FeatureAccess and Config\Options of most interest. Many of these settings can be generated into a .reg file independently of entry into a registry by using the IP Agent Con-figuration Utility, and it is highly recommended that a customer generate a base .reg file with this utility can these use in-formation in this document to further understand, add to and subtract from a specific configuration with information con-tained in this document. In particular, Screen Pop configuration cannot be specified within the Administration Utility. In-formation in this document should allow the customer to include such specification in a desktop push.

HKEY_LOCAL_MACHINE\Software\Avaya\PassageWay This root key includes system level configuration information used by the TAPI service provider, and set at application in-stallation. It is strongly advised that customers not tamper with information in this registry hive and sub-hives.

HKEY_LOCAL_MACHINE\Software\Avaya\iClarity

This root key includes system level configuration information used by iClarity and audio components. It is strongly ad-vised that customers not tamper with information in this registry hive and sub-hives.

HKEY_CURRENT_USER\Software\Avaya\iClarity

Issue 2.0

Page 4

This is the second root key that provides most of the end-user specific configuration parameters. Here are found settings that control the initial logon and registration with the Communication Manager Switch, accessible from the File | Station Login dialog, automatically presented to the user when the application starts, or hidden entirely with an automated login attempt when the application starts. A second configuration tool, the iClarity Administrator Controls (iClarityAdmin.exe), is also available to generate registry settings independently of the application user interface applicable to almost all settings available in this hive. In addition, iClarityAdmin.exe provides other customization options that are not available directly from the standard user interface pre-sented by this dialog. It is highly recommended that the registry files generated by this tool be examined and then cus-tomized as required by the information contained in this document.

HKEY_CURRENT_USER\Software\Avaya\Avaya Web Dialer This root key includes user level configuration for the Avaya Web Dialer Internet Explorer add-in for the Click to Dial Fea-ture. Of most interest is the key that allows specification of the highlighted format by Microsoft Visual Basic Regular Ex-pressions.

3. CONFIGURATION INFORMATION FOR RUN-TIME I-CLARITY INFORMATION. 3.1 SETTINGS ON THE FILE | LOGIN DIALOG

This is information relevant to the HKEY_CURRENT_USER\Software\Avaya\iClarity tree. The customer is again reminded that many settings documented here can be generated with the iClarityAdmin.exe tool, and any registration edits are best made on top of a .reg file that has been generated by this tool.

Key Entry Type Description

Options AudioParametersTuned DWORD Value=0 then run tuning wizard, value=1 tun-ing wizard already run

Options AudioPortRangeHigh DWORD Audio port range (high) configured on the network region of the switch. If not, then the value is default (65535)

Options AudioPortRangeLow DWORD Audio port range (low) configured on the network region of the switch. If not, then the value is default (1025)

Options AutoLogin DWORD Value=0 auto login turned OFF, value=1 auto login turned ON

Options BlockEmergencyCall DWORD Value=0 Emergency call handling feature en-abled, value=1 Emergency call handling fea-ture enabled

Options DontShowLoginStatus DWORD Value=0 Show login status when application starts, value=1 Do not show login status when application starts

Options E911DisclaimerShown DWORD Value=0 E911 status not shown or if the user hits "I disagree", value=1 E911 status shown and the user hits "I agree"

Options EmergencyPhoneNumber String E911 phone number configured on login screen

Options EmergencyPhoneNum1 String E911 phone number entered before and appear-ing in the drop down list. Can have up to 6 numbers. e.g. EmergencyPhoneNum2, Emergency-PhoneNum3

Options Extension String Extension of the station

Options Language String Language of Softphone (e.g. enu if running in English)

Options LocalIPAddress String IP address configured in the 'advanced' sec-tion for VPN interoperability.

Options NetworkBandwidth DWORD Value=2 for 28800bps or faster modem, value=3 for Cable, xDSL or ISDN and value=4 for Local Area Network

Options NumEmergencyPhoneNumbers DWORD Number of E911 numbers. Values=0 to 6

Issue 2.0

Page 5


Options OverrideLocalIPAddress DWORD Value=1 if IP address is configured under the local IP address information in the advanced tab. Otherwise value=0

Options Password String Password of the extension (encrypted)

Options PhoneNumber String Telecommuter phone number configured

Options PhoneNum1 String Other telecommuter phone number configured that appears in the drop down list.

Options PhoneNumWarning DWORD Value=0 if user chooses not to display the warning message after a telecommuter login. Otherwise value=1

Options PortHigh DWORD Highest port number of the port range config-ured in the advanced settings

Options PrimaryServer String Primary gatekeeper address

Options RegistrationParametersTuned DWORD Value=0 registration parameters not tuned, value=1 registration parameters tuned

Options RestrictPorts DWORD Value=0 port restriction disabled, value=1 port restriction enabled

Options SavePassword DWORD Value=0 do not remember password, value=1 remember password

Options ShowStationChangedWarning DWORD Value=0 no warning message is station type is changed, value=1 warning message if station type is changed

Options SuppressSilenceOption DWORD Value=0 silence suppression off, value=1 silence suppression ON

Options UseOwnExtForEmergencyCall DWORD Value=0 different extension for Emergency call, value=1 same extension for emergency call

Options ViewDebug DWORD Value=0 iClarity IP Audio view log is not selected, value=1 iClarity IP Audio view log is selected

Options VoiceConnectionType DWORD Value=0 road warrior, value=1 telecommuter

3.2 ENABLING OR DISABLING CONTROLS IN THE FILE | STATION LOGIN… DIALOG AND SUB-TABS. Function now presented has been requested many times by customers who require the ability to lock-down login settings for users, after they have been set centrally, and not allowi users to change these centrally provided and authorized settings.

Functions controlled by these entries are not available from the main application user interfaces. All entries are DWORD flags (0 | 1) (except one as noted) to enable (application default = 1) or disable (= 0) controls in the File | Station Login dialog, and so will be presented in an abbreviated table below. The Control will be identified by name in the Comment column. These Entries simply control the state of the respective input controls on the File | Station Login dialog. To actually set or preset control values, refer to the table in Section 3.1.

In a specific customer implementation, it is very likely that most of these options, especially the advanced ones, might be best dis-abled (flag = 0). Once again, it is recommended that a template of what is required be generated from the iClarityAdmin.exe tool, and the following information used to further customize or edit the ..reg file generated.

Key Entry Comment

Options\Admin EnableExt Enables or disables the “Extension:” control on main dialog or Login Set-tings | Login tab.

Options\Admin EnablePassword Enables or disables the “Password:” control on main dialog or Login Set-tings | Login tab.

Options\Admin EnableSettings Enables or disables the “Configura-tion:” control on main dialog.

Options\Admin EnableVoiceConnectionType This entry specifies what choices are

Issue 2.0

Page 6

Key Entry Comment available in the “Configuration:” combo box on the main dialog for VoIP Audio. It is a bitmap based on the low 5 bits.

X01 = IM Only

X02 = Shared Control from the IP Phone

X04 = Shared Control from the Server

X08 = Telecommuter

X10 = Road Warrior

For combinations, add the individual hexadecimal values.

X00 disables all choices and doesn’t even present the box to the user.

Options\Admin EnableTelephoneAt This entry specifies what choices are available in the “Telephone At” combo box when in Telecommuter mode. The ap-plication maintains the six most recent entries in PhoneNum1 – PhoneNum6. Note these entries in the top half of the sample .reg file below. This is a com-posite bit map specifying

X01 for PhoneNum1

X02 for PhoneNum2

X04 for PhoneNum3

X08 for PhoneNum4

X10 for PhoneNum5

X20 for PhoneNum6.

For multiple choices, add the individ-ual entries.

X00 presents no entries for user choice.

Options\Admin EnableCallServer Enables or disables the “Call Server Address:” control on the main dialog or the Login Settings| Call Server tab.

Options\Admin EnableBandwidth Specifies the choices that are avail-able in the “Bandwidth:” combo box on the main Dialog and on the Login Set-tings | Audio. It is a bitmap on the low three bits.

X01 28800 or better modem

X02 Cable or DSL Model

X04 LAN.

X00 will disable all user choices and not even show the box. Multiple choices are specified by adding the in-dividual choice settings.

Options\Admin EnableDialProperties Enables or disables the “Properties:” button next to the “Dialing Location:” control on the main dialog or the Login properties | Login tab.

Options\Admin EnableIMServerAddress Enables or disables the “Server Ad-dress:” input box on the Login Settings | IM tab.

Options\Admin EnableSaveExtPassword Enables or disables the checkbox “Re-member password for next login ses-

Issue 2.0

Page 7

Key Entry Comment sion.”

Options\Admin EnableAutoLogin Enables or disables the checkbox “Auto-matically log in if possible when ap-plication restarts.”

Options\Admin EnableIMLogin Enables or disables the checkbox “Log in to Avaya instant messaging server” on the main dialog

Options\Admin EnableAlternateServers Enables or disables the Alternate Serv-ers control in the Login Settings | Call Server tab.

Options\Admin EnableIMUserName Enables or disables the “User Name” in-put box on the Login Settings | IM tab.

Options\Admin EnableIMPassword Enables or disables the “Password:” in-put box on the Login Settings | IM tab.

Options\Admin EnableSaveIMPassword Enables or disables the “Remember pass-word for next login session” check box on the Login Settings | IM tab.

Options\Admin EnableLowPort Enables or disables the input box “Low-est Port Number” on the Login Settings | Advanced tab.

Options\Admin EnableHighPort Enables or disables the input box “Highest Port Number” on the Login Set-tings | Advanced tab.

Options\Admin EnableSettingsLogin Enables or Disables the Login Settings | Login tab.

Options\Admin EnableSettingsCallServer Enables or disables the Login Settings | Call Server tab

Options\Admin EnableSettingsIM Enables or disables the Login Settings | IM tab.

Options\Admin EnableSettingsAudio Enables or disables the Login Settings | Audio tab.

Options\Admin EnableSettingsEmergency Enables or disables the Login Settings | Emergency Tab

Options\Admin EnableSettingsAdvanced Enables or disables the Login Settings | Advanced tab.

Options\Admin EnableManualIP Enables or disables the checkbox “Use the following IP Address” on the Login Settings | Advanced tab.

Options\Admin EnablePortSelection Enables or disables the check box “Choose from the following port range…” on the Login Settings | Advanced tab.

Options\Admin EnableUseManualIP Enables or disables the check box “Use the following IP Address” on the Login Settings | Advanced tab.

Options\Admin EnableEmergencyCallHandling Enables or disables the check box “En-able Emergency Call handling” on the Login Settings | Emergency tab.

Options\Admin EnableUseExtForEmergencyNum Enables or disables the “Your Exten-sion…” radio button on the Login Set-tings | Emergency tab.

Options\Admin EnableEmergencyNum Provides choices of up to six external numbers in the Telephone Number combo box in Login Settings | Emergency tab. These numbers are managed by the appli-cation as EmergencyPhoneNumber1 – Emer-gency PhoneNumber6. Value is a compos-ite 6 bit bitmap, where

Issue 2.0

Page 8

Key Entry Comment

X01 EmergencyPhoneNumber1






For multiple choices, add the corre-sponding entries.

X00 Disables this entire control.

Note that even if given access to this control, any choice or input here may be incompatible with the setting for the extension in Communication Manager, and the user will not be allowed to register with the switch.

Options\Admin EnableInternalRinging Type DWORD. Enables (=1) or Dis-ables(=0) the “Play ringing through the internal PC speaker” on the Audio | Volume and Ringer Serttings.

A sample of a registry file generated by iClarityAdmin.exe follows. The Options section is explained in Section 3.1 and Op-tions\Admin section shows a “default” with all controls active, as explained in Section 3.2. Note the last two keys in this file are held in reserve for Avaya, and are not further documented.

Windows Registry Editor Version 5.00

[HKEY_CURRENT_USER\Software\Avaya\iClarity\Options] "Extension"="5374" "SavePassword"=dword:00000001 "PrimaryServer"="135.11.156.10" "NumAlternateServers"=dword:00000000 "VoiceConnectionType"=dword:00000002 "H323RegistrationSkipped"=dword:00000000 "NetworkBandwidth"=dword:00000004 "PhoneNumber"="96853655" "NumPhoneNumbers"=dword:00000006 "BlockEmergencyCall"=dword:00000000 "UseOwnExtForEmergencyCall"=dword:00000001 "EmergencyPhoneNumber"="" "NumEmergencyPhoneNumbers"=dword:00000000 "AutoLogin"=dword:00000001 "DialupID"=dword:00000001 "DialupLocation"="My Location" "OverrideLocalIPAddress"=dword:00000000 "LocalIPAddress"="135.11.154.114" "RestrictPorts"=dword:00000000 "PortLow"=dword:00000401 "PortHigh"=dword:0000ffff "IPTelephoneAddress"="" "VirtualLocalIPAddress"="135.11.154.114" "DontShowLoginStatus"=dword:00000001 "PhoneNum1"="6926" "PhoneNum2"="917328522014" "PhoneNum3"="917328522075" "PhoneNum4"="917328522147" "PhoneNum5"="2630" "PhoneNum6"="96853655" "IMFeatureEnabled"=dword:00000001

Issue 2.0

Page 9

[HKEY_CURRENT_USER\Software\Avaya\iClarity\Options\Admin] "EnableExt"=dword:00000001 "EnablePassword"=dword:00000001 "EnableSettings"=dword:00000001 "EnableVoiceConnectionType"=dword:0000001f "EnableTelephoneAt"=dword:0000003f "EnableCallServer"=dword:00000001 "EnableBandwidth"=dword:00000007 "EnableDialProperties"=dword:00000001 "EnableIPTelephoneAddress"=dword:00000001 "EnableIMServerAddress"=dword:00000001 "EnableSaveExtPassword"=dword:00000001 "EnableAutoLogin"=dword:00000001 "EnableIMLogin"=dword:00000001 "EnableAlternateServers"=dword:00000001 "EnableIMUserName"=dword:00000001 "EnableIMPassword"=dword:00000001 "EnableSaveIMPassword"=dword:00000001 "EnableLowPort"=dword:00000001 "EnableHighPort"=dword:00000001 "EnableSettingsLogin"=dword:00000001 "EnableSettingsCallServer"=dword:00000001 "EnableSettingsIM"=dword:00000001 "EnableSettingsAudio"=dword:00000001 "EnableSettingsEmergency"=dword:00000001 "EnableSettingsAdvanced"=dword:00000001 "EnableManualIP"=dword:00000001 "EnablePortSelection"=dword:00000001 "EnableUseManualIP"=dword:00000001 "EnableEmergencyCallHandling"=dword:00000001 "EnableLoginStatusOnStart"=dword:00000001 "EnableIMAlias"=dword:00000001 "EnableLoginWizard"=dword:00000001 "EnableIMWizard"=dword:00000001 "EnableUseExtForEmergencyNum"=dword:00000001 "EnableEmergencyNum"=dword:0000003f [HKEY_CURRENT_USER\Software\Avaya\iClarity\Options\Services] "ServerAddresses"="" "LoginToIMServer"=dword:00000000 "RememberPassword"=dword:00000001 "UseIM"=dword:00000001 "IMConfigured"=dword:00000001 [HKEY_CURRENT_USER\Software\Avaya\iClarity\Options\Services\Accounts] "NumAccounts"=dword:00000000

4. APPLICATION RUNTIME CONFIGURATION INFORMATION In the following sections, there is a list of many configuration registry entries used by the Avaya IP Agent application in addition to the basic login and registration functions in Section 3 of this document. Due to the length of this section, it is broken into sections based upon the Registry key under Avaya IP Agent.

Issue 2.0

Page 10

4.1 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA IP AGENT


Config BackupDB =

{ 0 | 1 }

DWORD Registry item determines whether or not to backup the end-users database based on a configured day(s) inter-val.

0 : Disable Automatic Database Backup (default)

1 : Enable Automatic Database Backup

Config DatabasePath =

<path>

String The current path to the <DatabaseName> where the appli-cation database resides. This is defined in the path item reference section above as %APP_DATA_PATH%

Config DaysBetweenBackup = <value>

DWORD Registry item determines the number of elapsed days be-tween database backups. If BackupDB is enabled, the interval (days) a vaid value must be set between 0 thru 99.

Default: 7

Valid Range: 0 to 99

Config GreetingsPath =

<path>

String Registry item provides the current path to the IP Agent audio greeting files and to the location of the greet-ings.tbl file. This is defined in the path items refer-ence section as: %GREETINGS_PATH%

Config Language =

<3 character language code>

String Registry item is used to determine which language re-sources to load by default where the /lang xxx is not passed in the command line property when launching Avaya IP Agent.

Supported 3 character Language Codes :

enu : English (Default)

deu : German

eso : Spainsh

fra : French

ita : Italian

ptb : Portuguese

jpn : Japanese

chn : Simplified Chinese

kor : Korean

nld : Dutch

rus : Russian

Config SoftwareUpdate =

{ 0 | 1 }

DWORD Registry item can be initialized during a custom install of Avaya IP Agent.

0 : Software Update Feature disabled (default)

1 : Software Update Feature enabled.

Config UpdateAddress =

<HTTP URL>

String Registry item which determines the URL which is used to attempt to perform a software update.

(example: http://www.mycompany.com/ipagentupdate)

Value : Empty (default)

Issue 2.0

Page 11


Config VoiceMessageNumber =

<value>

String Registry item contains the phone number to be dialed. See VoiceMessageType (1).

Examples:

9, +1 (555) 555-5555

9, +1 (555) 555-1234


Config VoiceMessageProgram =

<fully qualified path to executable>

String Registry item contains the path to the application to a voice message application. See VoiceMessageType (2).

Example:

C:\Program Files\abccompany\voicemsg\mm.exe)


Config VoiceMessageType =

{ 0 | 1 | 2 | 3 }

DWORD Defines the action when the voice message icon is pressed.

0 : Do nothing (default)

1 : Dial Number defined for voice message Config regis-try item: VoiceMessageNumber

2 : Launch Program defined for voice message Config reg-istry item: VoiceMessageProgram

3 : Launch Browser and goto URL defined for voice mes-sage Config registry item: VoiceMessageUrl

Config VoiceMessageUrl =

<URL>

String Registry item contains the URL path to the Voice Message web site. See VoiceMessageType (3).

Example:

http://mycompany.com/webmsg/scripts/start.asp)


EventLog Log =

{ 0 | 1 }

DWORD Registry item determines whether or not to generate the Avaya IP Agent Event Log which is used for diagnostic purposes.

0 : Application Event Logging Disabled (default)

1 : Application Event Logging Enabled

Note: Enabling logging will impact the overall perform-ance of IP Agent and should only be used to diagnosis and troubleshoot application problems.

EventLog XMLUtilLogging =

{ 0 | 1 }

DWORD Registry item determines whether or not to generate the Avaya IP Agent XML Utility Shared Data Migration Log which is used for diagnostic purposes.

0 : XML Utility Event Logging Disabled (default)

1 : XML Utility Event Logging Enabled

Note: Enabling logging may impact the overall perform-ance of IP Agent and should only be used to diagnosis and troubleshoot application problems and not enabled during normal operations.

General AgentID =

<value>

String Registry item of the last AgentID used for logging into the ACD.

Example: 3000


Issue 2.0

Page 12


Settings HideCallTimer =

{ 0 | 1 }

DWORD Used to indicate whether or not to hide the call timer on the call appearance display.

0 = Do not hide the call timer (default)

1 = Hide the call timer

General RetainAgentLoginID =

( 0 | 1 )

DWORD If 0, the agent logon dialog is not populated with the currently stored Agent ID

If 1, the agent logon dialog is populated with the cur-rently stored Agent ID

EventLog ModuleListCapture =

( 0 | 1 )

DWORD If 0, disables the capture of GPF Module List File

If 1, enables the capture of the GPF Module List File (default)

The module list file is contained in:

<WinDrive>:\Documents and Settings\[user]\Application Data\Avaya\Avaya IP Agent\Log Files\Module_List_(mm-dd-yyyy hh.mm.ss).txt

EventLog MiniDumpCapture =

( 0 | 1 )

DWORD If 0, disables the capture of GPF Mini Dump File

If 1, enables the capture of the GPF Mini Dump File (default)

The GPF mini dump file is contained in:

<WinDrive>:\Documents and Settings\[user]\Application Data\Avaya\Avaya IP Agent\Log Files\Diagnostic_(mm-dd-yyyy hh.mm.ss).dmp

4.2 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA IP AGENT\CONFIG


FeatureAccess AgentGreetings =

{ 0 | 1 | 4 }

DWORD Restricts Access to Agent Greetings

0 : Unrestricted (default)

1 : Disable Modification

4 : Disable Access to the Feature

FeatureAccess AudioMonitor =

{ 0 | 4 }

DWORD Changes restrictions for accessing the iClarity audio monitor.



FeatureAccess AudioOptions =

{ 0 | 4 }

DWORD Changes restrictions for accessing the iClarity audio options.



FeatureAccess AudioTuningWizard =

{ 0 | 4 }

DWORD Changes restrictions for accessing the iClarity audio tuning wizard.



Issue 2.0

Page 13


FeatureAccess CallHistory =

{ 0 | 1 | 4 }

DWORD Restricts Access to Contact History (aka Call History)



4 : Disable Access to Feature

FeatureAccess ConfigAdmin =

{ 0 | 4 }

DWORD Changes restrictions for accessing the Avaya IP Agent Configuration feature.

0 : Unrestricted

4 : Disable Access to the Feature (default) – (Not pass-word protected)

FeatureAccess ExportSettings =

{ 0 | 4 }

DWORD Changes restrictions for accessing the Avaya IP Agent Export Settings feature.



FeatureAccess ImportSettings =

{ 0 | 4 }

DWORD Changes restrictions for accessing the Avaya IP Agent Import Settings feature.



FeatureAccess LaunchToolbar =

{ 0 | 1 | 4 }

DWORD Changes restrictions for the Launch Toolbar feature.




FeatureAccess Password =

<encrypted pass-word>

String Contains the encrypted Administration Password used to lock down access to IP Agent features.

FeatureAccess PhoneDirectory =

{ 0 | 1 | 4 }

DWORD Restricts Access to Contacts (aka Phone Directory)



4 : Disable Access to Feature

FeatureAccess PhoneFeatures =

{ 0 | 1 | 4 }

DWORD Changes restrictions for the Phone Features.




FeatureAccess ProgramOptions =

{ 0 | 1 }

DWORD Changes restrictions for the Program Options Feature.



FeatureAccess PublicSearch =

{ 0 | 1 | 4 }

DWORD Changes restrictions for the Public Directory feature.




Issue 2.0

Page 14


FeatureAccess ScreenPops =

{ 0 | 1 | 2 | 3 | 4 }

DWORD Changes restrictions for the Screen Pops feature.



2 : Disable Selection

3 : Disable Selection AND Disable Modification


FeatureAccess SpeedDials =

{ 0 | 1 | 4 }

DWORD Changes restrictions for the Speed Dial feature.




FeatureAccess VuStats =

{ 0 | 1 | 4 }

DWORD Changes restrictions for the VuStats feature.




FeatureAccess WebDialer =

{ 0 | 1 | 4 }

DWORD Changes restrictions for the Desktop Integration feature (Highlight numbers by the Avaya Web Dialer in web con-tent using Microsoft Internet Explorer.




LDAPServers Current =

<value>

String Contains the currently selected user defined LDAP Ser-vice for Search Public Directory.

Options AgentLogin =

{ 0 | 1 }

DWORD Registry item which determines whether or not to prompt for the agent ID and password during agent login.

0 : Do not prompt

1 : Prompt for agent id and password. (default)

Options AlwaysOnTop =

{ 0 | 1 }

DWORD Registry item which determines whether or not to make Avaya IP Agent main application window the topmost win-dow.

0 : Allow other windows to cover the main Avaya IP Agent application window (default)

1 : Always display the main window on top.

Options AssistedDialing =

{ 0 | 1 }

DWORD Registry item determines whether or not to accept voice call requests from other third party programs.

0 : Disallow

1 : Allow (default)

Options AutoAgentLogin =

{ 0 | 1 }

DWORD Registry item which determines whether or not a login to the ACD (Automatic Call Distribution) is automatically attempted after a successful station login. (EAS Only)

0 : Disabled (default)

1 : Enabled

Issue 2.0

Page 15


Options AutoAnswer =

{ 0 | 1 }

DWORD Registry item where Auto Answer support is required. If the registry item is enabled, the station must also be administered for auto answer as well.


1 : Enabled

Options BasicTransfer =

{ 0 | 1 }

DWORD Enabled registry item transfers calls just like a regu-lar phone by pressing Transfer, dial the number, press Transfer again.

Used to set the preferred call transfer behavior. Set-ting is Mutually Exclusive to other call handling trans-fer registry item [BasicTransfer OR BlindTransfer OR EnhancedTransfer]

0 : Disabled

1 : Enabled (default)

Options BlindTransfer =

{ 0 | 1 }

DWORD Enabled registry item (Unsupervised Transfer) after the number is entered, the call is immediately transferred.



1 : Enabled

Options DialpadLetters =

{ 0 | 1 }

DWORD Registry item determines whether or not letters are dis-played on the dial pad (ie. 2 ABC, 3 DEF, 4 GHI…)

0 : Show only dialpad numbers

1 : Show dialpad numbers and dialpad letters (default)

Options EasDefinity =

{ 0 | 1 }

DWORD Registry item is configured to indicate whether or not the ACD supports (EAS) Expert Agent Selection.

0 : Non-EAS agent support

1 : EAS agent support (default)

Options Enable10Digits =

{ 0 | 1 }

DWORD Registry item determines whether or not a 10 digit dial plan should be used for internal calls.


1 : Enabled


{ 0 | 1 }



1 : Enabled


{ 0 | 1 }



1 : Enabled

Issue 2.0

Page 16



{ 0 | 1 }



1 : Enabled


{ 0 | 1 }



1 : Enabled


{ 0 | 1 }



1 : Enabled


{ 0 | 1 }



1 : Enabled

Options EnhancedConference =

{ 0 | 1 }

DWORD Registry item determines whether or not to enable en-hance conferencing where after the number is entered and dialed, the agent which may join the conference call is first consulted before they are added to the conference call.


1 : Enabled

Options EnhancedTransfer =

{ 0 | 1 }

DWORD Registry item indicates the preferred call transfer be-havior used where after the number is entered and di-aled, the agent which may receive the transferred call is first consulted before the call is transferred to them.



1 : Enabled

Options FlashWindow =

{ 0 | 1 }

DWORD Registry item indicates whether or not the main applica-tion window should flash for all inbound calls.

0 : Do not flash window for incoming calls.

1 : Flash window for incoming calls. (default)

Options JapaneseFont =

{ 0 | 1 }

DWORD Registry option applies only when using Avaya IP Agent where OS language is enabled for Japanese usage.

0 : No do not use Kana font (Non Japanese default)

1 : Use Kana font

Issue 2.0

Page 17


Options LogIncoming =

{ 0 | 1 }

DWORD Registry item determines whether or not a contact record should be generated for an inbound call.

0 : Do not create an entry in Contact History for an Inbound call.

1 : Create an entry in Contact History for an Inbound call. (default)

Options LogOutgoing =

{ 0 | 1 }

DWORD Registry item determines whether or not a contact record should be generated for an outbound call.

0 : Do not create an entry in Contact History for an outbound call.

1 : Create an entry in Contact History for an outbound call. (default)

Options PopOnCall =

{ 0 | 1 }

DWORD Registry item determines whether or not the minimized application window should be displayed for all incoming calls.

0 : Do not display the main window for incoming calls. (default)

1 : Display the main window for incoming calls.

Options ReplaceDisplay =

{ 0 | 1 }

DWORD Registry item determines whether or not to attempt to a contact number database lookup and where the number is found, the corresponding contact name is then included on the call display.

0 : Disabled – Don’t replace

1 : Enabled – Replace call information with contact di-rectory entry. (default)

Options ReplaceTitle =

{ 0 | 1 }

DWORD Registry item determines whether or not to display call information on the main application window titlebar dur-ing a call.

0 : Disabled – Don’t change the application title bar

1 : Enabled – Update the main application title bar with call information. (default)

Options SavePassword =

{ 0 | 1 }

DWORD Registry item determines whether or not to save the agent login password between logins. (EAS only)

0 : Do not save the agent login password

1 : Save the agent login password (default)

Options ShortcutIcon =

{ 0 | 1 }

DWORD Registry item determines whether or not the Avaya IP Agent icon is displayed in the system tray and would allow additional (right-click the icon) menu options to be supported.

0 : Do not display application icon in the system tray

1 : Display the application icon in the system tray. (default)

Options ShowLabels =

{ 0 | 1 }

DWORD Determines whether or not button label captions appear on the main application toolbar for Drop, Transfer, Con-ference, Login, Auto-In, Manual-In, After Call, Aux Work buttons

0 : No not show button label captions.

1 : Show button label captions. (default)

Issue 2.0

Page 18


Options SpaceBar =

{ 0 | 1 }

DWORD Registry item determines whether or not the space bar key is disabled and cannot be used to release an active call.

0 = Enabled – Spacebar key can be used to release an active call

1 = Disabled – Spacebar key cannot be used to release an active call (default)

Options ToolTips =

{ 0 | 1 }

DWORD Registry item determines whether or not to display mouse-over tooltips on the application’s toolbars.

0 : Do not display tooltips for toolbars.

1 : Display tooltips for toolbars. (default)

Settings DirectoryMaxRecords =

<value>

DWORD Used to limit the maximum number of records allowed in the Phone Directory table.

Value : 1000 (default)

Settings DisplayInterval =

<value>

DWORD Used to determine the interval which VuStats are dis-played and expressed in milliseconds.

Valid range (5000 to 600000)


Settings FontSize =

<value>

DWORD Changes the font size used in the main window applica-tion UI for the call display.

Default font size value is: 14 (default)

Valid value range is: 8 to 18

Settings LogMonths =

<value>

DWORD Max number of months to keep contact records in contact history.

Default value is: 3 (default)


Settings MaxCityCode =

<value>

DWORD Used where the active dialing rules defined under Phone and Modem Options control panel applet for Coun-try/region is NOT United States. Registry item contains the maximum number of digits in city code.



Settings MaxPhoneNumber =

<value>

DWORD Used where the active dialing rules defined under Phone and Modem Options control panel applet for Coun-try/region is NOT United States. Registry item contains the maximum number of digits in phone number, including city code.



Settings MinPhoneNumber =

<value>

DWORD Used where the active dialing rules defined under Phone and Modem Options control panel applet for Coun-try/region is NOT United States. Registry item contains the minimum number of digits in phone number, including city code.



Issue 2.0

Page 19


Settings RecentCalls =

<value>

DWORD Used to indicate the number of recent contacts displayed

Default value is: 6


Settings RecentCalls =

<value>

DWORD Used to indicate the maximum items to maintain in the call history button dropdown list of recent calls.

Value: 6 (default)


Settings RefreshInterval =

{ 1000 | 10000

| 30000 | 60000 | 120000 }

Used to determine the interval which VuStats are re-freshed and expressed in milliseconds.


1000 : 1 second interval

10000 : 10 seconds interval

30000 : 30 seconds interval

60000 : 60 seconds interval (default)

120000 : 2 minutes interval

Settings TrackPresenceLimit =

<value>

DWORD Used to trigger a warning message where the number of contacts presence being tracked has been exceeded and may impact the local presence application performance.


Settings WarnTrackPresence =

{ 0 | 1 }

DWORD Used to indicate whether a warning message will be dis-played to the end-user once the number of Track-PresenceLimit has been exceeded.

0 : Do not display warning message

1 : Display the warning message once the Track-PresenceLimit number has been exceeded. (default)

4.3 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA IP AGENT\CONFIG\LDAPSERVERS


[user defined Public Directory Name]

Example:

My Public Direc-tory

address = <value>

String Contains the LDAP Server address

Example:

ldap.employee.company.com


bindSelection = { 0 | 1 }

DWORD Determines the binding selection type

0 : Active Directory GSS Bind

1 : Simple Bind


logon =

<value>

String ID used to log into the LDAP service

Default : Empty

Issue 2.0

Page 20



maximumHits =

<value>

DWORD Maximum number of queried items returned.

Default : 200


password =

<value>

String Password for Login ID used to log into the LDAP service.

Default : Empty


port DWORD LDAP Server Port assignment used to connect to the LDAP service.

Default: 389


timeout DWORD Maximum number of seconds to wait for search results.

Default: 200

4.4 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA IP AGENT\CONFIG\SCREENPOPS None of these registry settings are generated by the IP Agent Configuration Utility.

If it is desired to include “pre-configured” screen pops into a desktop distribution, it is highly recommend that a trial screen pop is first of all configured from the IP Agent GUI (Tools | Screen Pops), tested and saved to the registry. Those registry entries can then be examined and further customized with the following information, and then re-tested. Only then should all the registry keys in this hive be exported into a .reg file and delivered to a target desktop.


Issue 2.0

Page 21


[screen pop name]

Address =

<value>

String Used in conjunction with WindowsExplorer screen pops to indicate the URL or the fully qualified executable path.

Example:

http://www.mycompany.com/data?tel=%n

Supported replacement tokens which can be in the Ad-dress registry entry and are dependent on selected call state triggers are:

Caller Name (%n) : (Valid for Call State Triggers for : Ringing | Missed | Answered | Released | Connected | Released – Outbound )

Caller Number (%m} : (Valid for Call State Triggers for: Ringing | Missed | Answered | Released | Con-nected | Released – Outbound )

Prompted Digits (%p) : (Valid for Call State Triggers for : Ringing | Missed | Answered | Released )

VDN (%v) : (Valid for Call State Triggers for: Ringing | Missed | Answered | Released )

UUI (%u) : (Valid for Call States Triggers for: Ring-ing | Answered )

Start Time (%s) : (Valid for Call States Triggers for : Ringing | Missed | Answered | Released | Connected | Released – Outbound )

End Time (%e) : (Valid for Call States Triggers for: Missed | Released | Released – Outbound )

Date (%d) (Valid for Call States Triggers for : Ring-ing | Missed | Answered | Released | Connected | Re-leased – Outbound )

Value should be empty for DDE Screen Pop Definitions

[screen pop name]

CallState =

{ 1 | 2 | 3 | 4 | 5 }

DWORD Indicates which call event state the [screen pop name] definition is triggered.

1 : Ringing (Incoming Call Only) – Not recommended where auto-answer station feature is enabled.

2 : Answered (Incoming Call Only)

3 : Missed (Incoming Call Only)

4 : Released (Incoming | Outbound Call)

5 : Connected (Outbound Call Only)

Issue 2.0

Page 22


[screen pop name]

Command =

<value>

String Contains the DDE (Dynamic Data Exchange) Command value for the screen pop definition.

Supported replacement tokens which can be in the Com-mand registry entry and are dependent on selected call state triggers are:









Value should be empty for Windows Explorer Screen Pop Definitions

[screen pop name]

DataExchange =

{ 0 | 1 }

DWORD Used to determine whether or not this is a DDE (Dy-namic Data Exchange) Screen Pop definition.

0 = Not a DDE Screen Pop Definition

1 = DDE Screen Pop Definition

Note: Assign to 0 for Windows Explorer Screen Pops

[screen pop name]

DateFormat =

<value>

String Used to override the replacement token in all screen pop definitions for Date.

Default : %d

[screen pop name]

Example:

My Screen Pop

Enabled =

{ 0 | 1 }

DWORD Indicates whether or not the [screen pop name] defini-tion is enabled.

0 : Disabled

1 : Enabled

[screen pop name]

EndTimeFormat =

<value>

String Used to override the replacement token in all screen pop definitions for End Time.

Default : %e

[screen pop name]

Function =

{ 0 | 1 }

DWORD Used to indicate whether the DDE (Dynamic Data Ex-change) Screen Pop Definition should use either the (Poke Item and Poke Item Data) or the (Execute Com-mand) DDE conversion method.

0 = Use Poke Item / Poke Item Data

1 = Use Execute Command

Value ignored for Windows Explorer Screen Pop Defini-tions

Issue 2.0

Page 23


[screen pop name]

IncomingCall =

{ 0 | 1 }

DWORD Indicates whether or not the [screen pop name] defini-tion is triggered either by an Inbound or Outbound call event.

0 : Screen Pop triggered by Outbound Call

1 : Screen Pop triggered by Inbound Call

[screen pop name]

Item =

<value>

String Contains the DDE (Dynamic Data Exchange) Item value for the screen pop definition.


[screen pop name]

ItemData =

<value>

String Contains the DDE (Dynamic Data Exchange) Item Data value for the screen pop definition.

Supported replacement tokens which can be in the Item-Data registry entry and are dependent on selected call state triggers are:










[screen pop name]

NameFormatString =

<value>

String Used to override the replacement token in all screen pop definitions for Caller Name.

Default : %n

[screen pop name]

NumberFormatString =

<value>

String Used to override the replacement token in all screen pop definitions for Caller Number.

Default : %m

[screen pop name]

PopOnVdn =

{ 0 | 1 }

DWORD Determines whether or not a Vdn value should be com-pared with an Inbound call to trigger the screen pop.

Value should be blank for outbound triggered screen pop definitions.

Issue 2.0

Page 24


[screen pop name]

PromptedFormatString =

<value>

String Used to override the replacement token in all screen pop definitions for Prompted Digits.

Default : %p

[screen pop name]

Service =

<value>

String Contains the DDE (Dynamic Data Exchange) Service value for the screen pop definition.


[screen pop name]

StartTimeFormat =

<value>

String Used to override the replacement token in all screen pop definitions for Start Time.

Default : %s

[screen pop name]

Topic =

<value>

String Contains the DDE (Dynamic Data Exchange) Topic value for the screen pop definition.


[screen pop name]

UuiFormatString =

<value>

String Used to override the replacement token in all screen pop definitions for UUI.

Default : %u

[screen pop name]

Vdn =

<value>

String Vdn string used to compare with an Inbound call for PopOnVdn enabled screen pops.


[screen pop name]

VdnFormatString =

<value>

String Used to override the replacement token in all screen pop definitions for VDN.

Default : %v

[screen pop name]

WindowsExplorer =

{ 0 | 1 }

DWORD Used to determine whether or not this is a Windows Explorer Screen Pop definition.

0 = Not a Windows Explorer Pop Definition

1 = Windows Explorer Screen Pop Definition

Note: Assign to 0 for DDE Screen Pop Definitions

Issue 2.0

Page 25

4.5 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA IP AGENT\CONFIG\SCREENPOPS\[SCREEN POP NAME]


Format-[0 to 4]

[0 to 4] corresponds to indexed ordered position of each of the assigned replacement tokens]

Format =

{0 | 1 }

DWORD Used to indicate whether or not a replacement token needs ad-ditional formatting before comparison usage for conditional runtime triggering of a screen pop definition.

0 = No formatting of the corresponding position of Format-[0 to 4] for the respective assigned replacement token defined.

1 = Formatting is required for the corresponding position of Format-[0 to 4] for the respective assigned replacement token.

Format-[0 to 4]

Length =

<value>

DWORD Used for determining the number of characters to include which will be used for string comparison purposes.

Valid Range (1 to 40)

Format-[0 to 4]

Location =

<value>

DWORD Used for determining from what the starting location will be used to parse the source string and then will be used for string comparison purposes.

1 = Left

2 = Middle

3 = Right

Format-[0 to 4]

StartAt =

<value>

DWORD Used for determining the starting at character position used for string comparison purposes. StartAt value is only used where the Location registry item is assigned to (2) Middle.

Valid Range (2 to 40)

4.6 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA IP AGENT\GENERAL


CurrentCategory Category =

<value>

String Last selected user-defined contact item category for the Cate-gories (See Categories) created for the end-user’s contact directory.

Example:

All Categories (default)

Sales

Personal

Business

Categories [user-defined catego-ries]

Examples:

Sales

Personal

Business

String Entries list is enumerated and is used to populate the drop-down list box containing categories which can be assigned to a given contact in the contact directory.

Value : Empty (Not Used)

Issue 2.0

Page 26

4.7 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA IP AGENT\GENERAL\TOOLBARLAUNCH It is recommended that a trial configuration be generated from the IP Agent application (View | Toolbars | Configure Launch Tool-bar…), tested and saved. Then if customizations are to be made, the following information may be useful. Remember that the en-tire hive must be exported to the target desktop.


[nn] (Index Position)

Examples:

01

02

(Valid Range 00 to 22)

DefaultDirec-tory =

<value>

Expanded

String

Contains the fully qualified path of the directory that con-tains the file specified by the launch item Filename. If this parameter is not specified, the current working direc-tory is used.

Examples:

%PROGRAMFILES%\Microsoft Office\Office12

C:\Program Files\Microsoft Office\Office12

C:\My Folder

Note: Use of environmental variables such as %PROGRAMFILES% can be used in this registry item instead of a hardcoded folder path (i.e. C:\Program Files)


Description =

<value>

String Contains a short description to explain the general purpose of the user assigned launched toolbar button.

Examples:

Launches the Avaya IP Agent Application User Guide

Launches Microsoft Internet Explorer

This value will appear in the main application window’s status bar for the launch item button where the mouse is hovered over the respective launch toolbar button.


Enabled =

{ 0 | 1 }

DWORD Determines whether or not the launch toolbar button is en-abled (visible) on the launch toolbar.

0 : Disabled / Not Visible (Default)

1 : Enabled and Visible – Note that a launch item may not be immediately visible where {EXTENSION} or {AGENT_ID} tokens parameters are defined. See Parameters for more details.


Filename =

<value>

Expanded String

User assigned executable or folder path. Expanded String value that contains the name of the file on which ShellExecute will perform the action as specified by the launch toolbar registry item called Operation.

Examples:

%PROGRAMFILES%\Microsoft Office\Office12\WINWORD.EXE

C:\Program Files\Microsoft Office\Office12\WINWORD.EXE

C:\My Folder

Note: Use of environmental variables such as %PROGRAMFILES% can be used in this registry item instead of a hard coded folder or executable path (i.e. C:\My Folder\myprogram.exe). All environmental variables are converted to physical paths prior to being passed to ShellExecute API.

Issue 2.0

Page 27



IconFilename =

<value>

Expand String

User assigned icon file to be used on the launch toolbar button. The Expanded String value contains the fully qualified path of name of the icon file to be used on the respective launch toolbar button.

Examples:

%PROGRAMFILES%\My Company\My Product\picture.ico

C:\Program Files\My Company\My Product\picture.ico

Note: Use of environmental variables such as %PROGRAMFILES% can be used in this registry item instead of a hard coded folder or executable path (i.e. C:\Program Files\My Com-pany\My Product\myicon.ico)


LaunchItemName =

<value>

String A user assigned name of the launch toolbar button item which appears in the left list box in the Configure Launch Toolbar window. This value will appear as a tooltip for the launch item button where tooltips in Avaya IP Agent are enabled.

Examples:

Avaya Voice Messaging Recorder

Microsoft Outlook

Microsoft Word


Operation =

<value>

String A string, referred to as a verb, that specifies the opera-tion to be performed. It should be set to one of the verb strings that is supported by the file. By default the con-figuration launch toolbar user interface will assign this value to “open”.

edit : Launches an editor and opens the document for edit-ing. If filename is not a document file, the function will fail.

explore : Explores the folder specified by filename

find : Initiates a search starting from the specified di-rectory.

open : Opens the file specified by filename. This file can be executable, a document file, or a folder. (Default – assigned/overridden by the launch toolbar configuration user interface)

print : Prints the document file specified by filename. If filename is not a document file, the function will fail.

Issue 2.0

Page 28



Parameters =

<value>

Expanded String

User assigned parameters passed to the launch toolbar item executable. If filename specifies a path to an executable file, parameters specifies the parameters to be passed to the application. The format of this string is determined by the operation verb that is to be invoked. If filename speci-fies a document file, Parameters should empty.

Example:

http://mycompany.com/contactcenter/extension={EXTENSION}

Special Runtime Tokens:

(EXTENSION} : {EXTENSION} placeholder token is replaced with the end-user’s actual login extension at application run-time. Where the {EXTENSION} token is defined, the launch toolbar button does not become visible until a successful login to the station has occurred.

{AGENT_ID} : {AGENT_ID} placeholder token is replaced with the end-user’s actual Agent ID login extension at applica-tion runtime. Where the {AGENT_ID} token is defined, the launch toolbar button does not become visible until a suc-cessful login to the ACD has occurred.

Note: Use of environmental variables such as %PROGRAMFILES% can be used in this registry item instead of a hard coded folder or executable path (i.e. C:\Program Files\My Com-pany\My Product\myprogram.exe)


ShowCmd =

{ 0 | 1 | 2 | 3 | 4 | 5 | 7 | 10 }

DWORD Recommends how the window that belongs to the application that performs the operation should be displayed initially. The application can ignore this recommendation. If this pa-rameter is not specified, the application uses its default value.

0 : Open the application with a hidden window.

1 : Open the application with a normal window. If the window is minimized or maximized, the system restores it to its original size and position. (Default – Assigned / overwrit-ten by the launch toolbar configuration user interface)

2 : Open the application with a minimized window.

3 : Open the application with a maximized window.

4 : Open the application with its window at its most recent size and position. The active window remains active.

5 : Open the application with its window at its current size

and position

7 : Open the application with a minimized window. The active window remains active.

10 : Open the application with its window in the default

state specified by the application.

Issue 2.0

Page 29

4.8 HKEY_CURRENT_USER\SOFTWARE\AVAYA\AVAYA WEB DIALER\CONFIG


Options BrowserParse =

{ 0 | 1 }

DWORD Registry item used by the Avaya Web Dialer to determine whether highlighting of identified phone numbers in web con-tent should be applied.


1 : Enabled

Note: Restart of Internet Explorer is also required to acti-vate the change in the Click-To-Dial (Avaya Web Dialer) add-in.

Options PhoneNumRegExp = <value>

String Used to override the regular expression used to identify phone numbers contained on a web page were BrowserParse has been enabled.

Default Value :

((\+?\s?1)?\s?-?\.?\(?\d{3}\)?\·?-?\.?\s?\\d{3}-?\.?\·?\s?\d{4})|(\+\d{1,3}-?\.?\·?\s?\(?\d{1,5}\)?-?\.?\·?\s?(\d-?\.?\·?\s?){7,11})