SAP Contact Center Client Workstation Guide: Operations Guide - Public Document Version: 13 - 2018-12-14
SAP Contact Center Client Workstation Guide: Operations Guide - Public Document Version: 13 - 2018-12-14
1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
7 Auto-Start. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
7.1 Configuring Auto-Start with Group Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
7.2 Configuring Auto-Start on One Workstation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
This guide describes how to set up a client workstation for different SAP Contact Center end-user applications,
and the files that are written at the workstation during the use of the software.
For the planning and installing servers and various applications, see the SAP Contact Center Installation Guide
document. For the configuration of the system and its users, see System Configurator application help.
For the basic installation and administration of your computer, its operating system and other prerequisite
software, refer to the documentation of the computer and corresponding software.
Some of the functions described in this guide may not be implemented in your system, or you may not have
permission to use some of the functions. Furthermore, your system may include separately implemented
customer-specific features that this guide does not cover. Contact the supplier or administrator for more
information.
Caution
The software users (service providers and end-users) are fully responsible for ensuring that the services
provided using this software do not violate or are not used in contravention of local legislation. The software
users must acknowledge that the software collects identification data for enabling the services and their
invoicing, security and troubleshooting, protecting the services against misuse and misappropriation, and
further improvement of the software and services, and they must assume the full responsibility for the use
of the collected data.
Document History
Document History
Version Date/Description
Use
Note
Infrastructure Administrator (IA) may not work perfectly when run on Windows Server versions older than
2012.
We recommend starting the System Configurator (SC) and Infrastructure Administrator (IA) with the web start
that can be launched from the Remote Administration Tools web page. Using web start ensures that the newest
installed software package is used.
As of 1705, SC can be accessed over DirectAccess from Internet. For more information, see . IA can be
accessed in the internal network only.
Prerequisites
● At least the databases, and virtual units where Remote Administration, Agent Server, and Connection
Server packages are installed, and up and running.
● Java SE Runtime 8, 32-bit edition must be installed on the computers where Infrastructure Administrator
(IA) or System Configurator (SC) is used.
Note
Note
Occasionally, downloading the new version jar file does not succeed but the Java web start uses the old jar
file from the Java cache, and the web start does not work. In that case, clear the Java cache in the following
way:
Note
Microsoft has informed that on September 9th 2014, Internet Explorer started blocking out-of-date ActiveX
controls. This does not affect SAP Contact Center end-user applications but Infrastructure Administrator
and System Configurator users may encounter this in environments where the following Java versions are
used:
● IE does not block the usage but displays a warning. You can choose to use the blocked Java by
selecting “Run this time”.
● Blocking is not applied to Local Intranet Zone or Trusted Sites Zone. Make sure that the
Remote Administration Tools site is on appropriate zone.
● Install the prerequisite software security updates when available.
Procedure
Infrastructure Administrator
1. Open you browser and go to the address [Website VU]/remoteadmin (or the virtual unit where Remote
Administration Tool package has been installed).
2. To start the application, click the Infrastructure Administrator button.
3. The Infrastructure Administration monitoring view opens.
To make changes to the system model, choose Connection Connect , and enter user name and
password of the Windows account dedicated for system administration.
System Configurator
1. Open you browser and go to the address [Website VU]/remoteadmin (or the virtual unit where Remote
Administration Tool package has been installed).
2. To start the application, click the System Configurator button.
3. A dialog window opens; enter your account user name and password. The default values are Admin and
12345678. The password must be changed at first logon, the new one must be at least 8 characters long.
4. Click Log On.
Troubleshooting
1. Make sure that during Remote Administration Tools package installation, the variables Connection
Server IP Address, Connection Server Port Number, and Connection Server Certificate Common Name are
properly defined. To view and change these definitions, click the Connection opening icon.
2. Make sure that the Connection Server-related certificate is properly installed, configured, and can be found
in Trusted Root.
Advanced Use
In ASP environment, where several independent SAP Contact Center systems may locate on same servers, you
can define additional connections so that you can start each system’s SC from the same Remote
Administration Tools page. Make sure you define all items of a connection right for that connection, and make
sure that the web start is of the same or newer software level than the software it is connecting to.
1. To open the connection view, click the opening icon. Define the following items:
○ Connection Name: Enter free-form text, for example the customer name, such as ACME.
○ IP Address: Enter the Connection Server’s IP address.
○ Port: Enter the Connection Server’s port, the default value is 21002.
○ Certificate: Enter the Connection Server certificate’s common name.
2. Click Save.
To delete a connection defined for reaching other systems’ SC, choose the connection from the pull-down
menu, click the opening icon, and choose Delete.
As of 1702, the direct web access to System Configurator (SC) can be enabled. For more information, see . It
requires that instead of Connection Server, the Connection Web Server module is installed in the system.
System administrators define the URL and provide SC users with the token they need to use to start SC in the
following way: https://[URL for Clients to Connect to Connection Web Server]/sc/
default.jsp?token=xyz.
As of 1705, it is possble to access SC over DirectAccess also when web access is used. For more information,
see .
Each SAP Contact Center application has its specific requirements, see the following sections
Prerequisites
● Software prerequisites: Microsoft Windows 7 or 10 operating system and Internet Explorer 11.
● Make sure that there are no 3rd party Internet Explorer add-ons, such as Google toolbar, installed on the
workstation. These 3rd party software can block CDT from opening, or affect the sound quality. If you are
using Microsofyt Skype, see Using CDT and Microsoft Skype Simultaneously [page 12].
● Configure the Internet Explorer security settings as defined, and see also settings affecting the UI
appearance [page 31].
● If client certificates are used for user authentication, or a trusted root is required for server certificates,
install the appropriate certificate on the client workstation. See the section Certificates on Client
Workstations [page 33].
● As of 1705, it is possible to use CDT over DirectAccess anywhere via internet if the administrator has
defined an appropriate NAT location, and client components of version 1705, or newer, are used. For more
information about NAT configuration, see System Configuration application help.
Procedure
1. Install the terminal component on the client workstation. See the chapter Installation of Client
Components [page 19].
2. Configure Microsoft Internet Explorer software:
○ Add the SAP Contact Center website to the trusted sites. Use the address of the virtual unit where the
Web Clients package has been installed.
○ Adjust the Internet Explorer security settings so that the system works but the maximum security is
ensured, see the chapter Internet Explorer Configuration [page 28].
3. Make sure that there are appropriate audio devices, and optionally a video camera installed on the client
workstation. See the chapter Installing Audio Devices and Video Cameras [page 38].
Make sure that the power saving setting of the operating system does not turn the USB device off when
it is inactive (see the settings MyComputer > Properties > Hardware > Device Manager >
Universal Serial Bus controllers > USB Root Hub-Properties > Power
Management). If the settings are available in BIOS, make sure the USB legacy settings are enabled
and the USB mouse and keyboard are supported.
4. To start the CDT, browse to the virtual unit address where the Web Clients packages has been installed,
http://[Website VU/cdt, and enter username and password.
As of 1705, if the DirectAccess is enabled, the address must be a fully qualified domain name, FQDN, with
the extension /cdt.
Additionally, it is possible to configure CDT to start automatically at user logon, see the chapter Auto-Start
[page 36]
Prerequisites
● Create a DNS address that points to Communication Panel, for example phone.company.com.
By default Communication Panel can be launched from https:// [Web Server VU address] /ecf/
[software version]/communicationpanel/index.html.
● Make sure there is an appropriate browser installed on the workstation, see the table below.
● If client certificates are used for user authentication, install the appropriate certificate on the client
workstation. See the section Certificates on Client Workstations [page 33].
● Make sure that there are appropriate audio devices installed on the client workstation. See the chapter
Installing Audio Devices and Video Cameras [page 38].
● To be able to receive chats, Communication Panel users need to have multi-chats enabled in System
Configurator User and Role Management > Users > Contact Settings > Multi-Chat Settings > Enable Multi-
Chats.
1. Start an incognito browser session, and browse to the DNS address that points to Communication Panel.
2. Enter username and password when required.
Note
Make sure that the power saving setting of the operating system does not turn the USB device off when it is
inactive (see the settings MyComputer > Properties > Hardware > Device Manager >
Universal Serial Bus controllers > USB Root Hub-Properties > Power Management). If
the settings are available in BIOS, make sure the USB legacy settings are enabled and the USB mouse and
keyboard are supported.
Communication Panel is based on CSS3, HTML5 and JavaScript API. That is why only browsers with HTML5
capabilities are supported. We recommend that you use the latest version of the browser.
Both CDT and Microsoft Skype (Lync) use the same Human Interface Device (HID) addresses to control the
USB audio device. If both are running simultaneously, Microsoft Lync may impair CDT audio stream.
System can be configured to reserve USB audio device specially for CDT. This scenario is supported only with
Jabra and Sennheiser devices listed on Compatibility List.
To reserve the audio device specifically for CDT, install terminal_HS_USBHS.msi headset driver. By default
the reservation feature is turned on. If you wish to disable it registry needs to be modified.
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\SAP\CCTRAXPXY
\HID_USE_JABRA_SPECIAL_COMMANDS
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\SAP\CCTRAXPXY\HID_USE_SH_SPECIAL_COMMANDS
Prerequisites
Procedure
1. To start the Online Monitoring, browse to the [Website VU]/monitor (address of the virtual unit where
the Monitoring Web Client has been installed).
or
1. Choose in CDT File Online Monitoring (if the link is enabled by administrator in System
Configurator).
3.5 Reporting
Prerequisites
Note
Rights to view reports cannot be defined in the System Configurator for a SAP Contact Center user
account, but they are defined for a Windows user account in Windows and SQL Reporting Services tools.
For more specific role definitions, see instructions in the Operation Guide.
You must have appropriate role defined for your Windows user account.
1. Start the Internet Explorer and browse the page [address of Reporting website]/reports.
2. To open the set of reports, click the appropriate folder. The folder name is defined during installation. If
several time zones are configured to the system, the folders of other zones can be found on this same site.
3. Language selection in SAP Contact Center does not effect Reporting but it follows the Internet Explorer
(IE) language. To change the language, define it in IE Tools Internet Options Languages . Note the
following exception:
○ If the chosen IE language is not supported by SAP Contact Center, English is used. The list of
supported languages is available in Communications Desktop application’s Settings view.
○ Language selection does not effect the Reporting Services -related items above the actual report, such
as search parameters and the View Report button. They follow the language option used in the
Microsoft SQL Server software. If the IE language is not supported by the SQL software, the installation
language is used.
○ Only the reports are available in different languages; the items saved in the database and displayed in
the reports, such as Outbound campaign comments, are available as they are entered in the database.
Communication Desktop (CDT) and Embedded Communication Framework (ECF) can be integrated with SAP
Cloud for Customer (C4C).
Customer data is displayed with incoming call, based on the caller number, called number, or call attached data
collected, for example, by an IVR application. Additionally, when the function is available on SAP CRM side, the
tickets based on e-mail, social media events, or customer incidents can be routed in SAP Contact Center to
optimize the queue, skill, and priority selection. On SAP Contact Center side the tickets are routed in e-mail
channel, and they are handled in CDT.
Note
Embedded CTI integration is supported in ECF only. With CDT you need CTI adapter.
ECF
ECF widget within the C4C user interface provides buttons for handling interactions.
Integration covers:
● Inbound calls
● Outbound calls (without click-to-call)
● Multi-chat
● Action items (in e-mail channel)
CDT
Contact handling, such as answering, transferring and hanging up, takes place in CDT.
Integration covers:
Prerequisites
● CDT components have been installed on workstations, see corresponding chapter in Taking End-User
Applications into Use [page 10].
● Access to the required SAP Cloud for Customer components:
○ SAP Contact Center Connector for SAP CRM Cloud (CloudConnector.msi) is available in SAP
Contact Center software in Client Workstation Components folder.
○ SAP CRM CTI Adaptor (SAPCODCTIClientAdapterSetup.exe) is available in SAP CRM OnDemand
software delivery.
● Add http:localhost to the trusted sites in Internet Explorer in Internet Options Security Trusted
Sites .
Installing Components
Note
● Install components in the following order, especially the SAP CRM CTI Adaptor must be installed before
the SAP Contact Center Connector for SAP CRM Cloud.
● As of FP11, the ClientCom component from the mctabuff.msi package can be used, and a separate
clientcom.msi is not delivered anymore.
1. For CDT users only: Install the ClientCOM component from the mctabuff.msi package on the
workstation.
You can activate the integration either for a queue (as of SP07), or for queue and direct contacts of certain
users using a user setting template (as of SP06).
1. In System Configurator, choose Queue Management Queues , and choose the queue.
2. In Integration Settings SAP Cloud for Customer Integration URL , enter the URL.
3. Save your entries.
1. In System Configurator, choose User and Role Management User Settings Template .
2. Open an existing template, or create a new one, and assign the integration users to it.
3. Choose the block SAP Cloud for Customer Integration and enter the URL in one or both of the following
fields:
○ To pop up the SAP CRM OnDemand screen with incoming direct (personal) contacts, enter the URL in
the field URL for Direct Calls.
○ To pop up the SAP CRM OnDemand screen with incoming queue contacts, enter the URL in the field
URL for Queue Calls.
4. Save your entries.
URL Format
● <xxxxx> is the port of the local host of your system, by default 36729.
● <yyyy> is the identification code, for SAP Contact Center the current value is BCM1234.
As of 1711, you can prevent certain contact events from being sent to C4C. Each contact event creates an object
in C4C and this may cause unnecessary objects to be created. Define the blocked events by adding one or
more of the following parameters after the URL, separated with an ampersand (&) character:
● CALL_ALLOCATED=SKIP
● CALL_CONNECTED=SKIP
● CALL_DISCONNECTED=SKIP
● CHAT_ALLOCATED=SKIP
● CHAT_CONNECTED=SKIP
● CHAT_DISCONNECTED=SKIP
● MAIL_CONNECTED=SKIP
● MAIL_DISCONNECTED=SKIP
In the following URL the events of allocated calls and disconnected calls are blocked, and only the
connected calls create an object in C4C:
http://localhost:36729/?CID=BCM1234&CALL_ALLOCATED=SKIP&CALL_DISCONNECTED=SKIP
Integrated Data
● CID: Identification code value. With SAP Contact Center integration, this value is BCM1234.
● DNIS: Dialed Number Identification Service
● ANI: Telephone number of the caller
● ExternalReferenceID: Call ID
Additionally, if there are any call attached data custom parameter values (for example, via a Customer
Recognition IVR application), they are included as such at the end of the URL. Contacts can include skills,
preferred agent and priority information for routing the contact to the right queue and agent.
1. Start the SAP Cloud for Customer CTI Client Adapter in the mode “run as administrator”. For more
information, contact SAP CRM Cloud support.
2. Log on to SAP CRM OnDemand /Cloud UI.
3. Log on to CDT.
After that, the customer information shall pop up upon incoming direct and/or queue calls or chats depending
on the System Configurator configuration above. If the contact includes an incident ID defined in the integrated
system, it may appear as a Ticket ID in CDT chat form.
If the CloudConnector.msi is installed, the user can click a phone number shown as a link in SAP CRM Cloud
UI to make a call.
Note that SAP CRM OnDemand /Cloud user interface does not provide any call handling controls, such as
answering, transferring, consulting, hanging up, and handling conferences, so the calls must be handled in CDT
or ECF.
As of SAP Contact Center version SP07 (7.0.7.0) the client workstation components can be installed and
updated automatically, if that is enabled on the server-side. The feature requires Internet Explorer version 8, or
later.
Note
When upgrading to 7.0.7.0 from an earlier version, do not start auto-update at the upgrading procedure but
install client components first from MSI packages in a traditional way. Take auto-update into use as a
separate project. If downgrading back to the earlier version is required, an additional removal procedure for
the auto-update feature is required, which may be difficult if not planned carefully.
For SAP Contact Center versions older than 7.0.7.0, the client components need to be installed on each client
workstation from MSI packages.
Note
Make sure that the prerequisites defined for each application are installed before installing the client
workstation components.
terminal_Proxy.msi The client end service that communi Works as a proxy between the terminal
cates with the CDT application. core component and the user interface.
CDT requires that terminal_Proxy is
installed.
Note
Install Proxy before other terminal
components.
Note
If the auto-update is in use, do not
install the MSI package.
terminal_HS_xxx.msi Device adaptor for the xxx headset. Requires that terminal_Core compo
nent is installed already, and if CDT is to
Special cases:
Note be used, also terminal_Proxy.
terminal_HS_USBHS.msi
If more than one headsets is used
on a workstation,
Note
terminal_HS_USBHS.msi must If the auto-update is in use, do not
be installed as well. It provides the install the MSI package.
The
terminal_HS_PlantronicsV3.
msi headset requires that a third-
party run-time package is installed
as well.
terminal.msi Complete package that includes all This package cannot be delivered with a
terminal_ packages listed above. group policy, it must be installed on
each client workstation separately.
Not available in cloud edition.
For demo and training purposes only,
not for production use.
mctabuff.msi Installs a ClientCOM ActiveX compo Not included in the complete terminal
nent required for Online Monitoring and package. Downloads automatically if
telephony integration with third parties. that is allowed in IE settings.
Note
As of FP11, this ClientCOM compo
nent works also with C4C integra
tion.
wvp.msi Video ActiveX component of CDT. En Not included in the complete terminal
ables sending and receiving video package.
stream.
Note
If the auto-update is in use, do not
install the MSI package.
clientcom.msi Installs SAP Contact Center ClientCom Not needed anymore as the ClientCOM
for SAP Cloud for Sales and Service, for
Obsolete, removed from the package in component from the mctabuff.msi
CDT only.
FP11, as also the folder SAP CRM Cloud package can be used.
Integration Components.
CloudConnector.msi Installs click-to-call function in SAP Not included in the complete terminal
Cloud for Customer. package.
Note
Make sure you install components
of SAP Cloud for Customer in right
order. For more information, see
Client Workstation Guide section
SAP Cloud for Customer Integra
tion.
Installation order:
Added in SP06.
Folder: 3rd_partyPlantronics > The Plantronics run-time package that Added in SP10.
SpokesSDKNativeRuntime.msi an updated Plantronics integration
component,
terminal_HS_PlantronicsV3.msi,
requires.
As of version SP07 (7.0.7.0), the telephony client terminal components can be installed and updated
automatically on workstations.
Note
To enable auto-update,
● Make sure that the Update Client Component Automatically checkbox is selected in IA in Variables for Web
Clients under all appropriate website virtual units.
When the user starts CDT for the first time with auto-update enabled, the client components are loaded in the
following way:
● terminal.inf
%TEMP% ● COM_Phone_7.0.7.X.dll
● handset_GNNetCOM_v10.dll
● handset_UsbHid_v10.dll
● handsets.ini
● Auto-update cannot update client components that are older than 7.0.7.0.
● Auto-update cannot update mctabuff.msi, clientcom.msi, CloudConnector.msi,
Convergence.msi, CalendarIntegration.msi, terminal_NET.msi they must be installed manually.
● Auto-update installs only the GNNetCom ja UsbHid (same as in HS_USBHS.msi) handsets. If you need
other handsets, install them manually from MSI packets.
● Do not install manually other packets than the exceptions listed above, otherwise auto-update may not
work.
Using auto-update requires that you follow the enabling instructions above carefully. Otherwise the scenarios
listed in the table below may occur, especially in a system upgraded from an earlier version.
Auto-update was used to install the cli Starting CDT fails because it cannot Install client components from the MSI
ent components, but later the Web Cli find phone components. packages, or enable auto-update again.
ents variable Update Client Component
Automatically is disabled.
Auto-update is used, but then the sys Starting CDT fails because it cannot An additional removal procedure for the
tem is downgraded to a version earlier find phone components. auto-update feature is required.
than 7.0.7.0.
Install the client components manually.
No client components are installed on Starting CDT fails because it cannot Enable auto-update in all website virtual
workstations and the Web Clients varia find phone components. units, or install client components from
ble Update Client Component MSI packages.
Automatically is not selected.
The client components installed on the workstation are not removed before starting to use auto-update:
7.0.7.0 version client components have Terminal components are updated au No issues.
been installed from MSI though auto- tomatically.
update is in use.
Older than 7.0.7.0 client components CDT starts with an old client compo Remove installed client components.
have been installed. nent, for example SP06, and it is not
updated automatically.
The Client Terminal Component Version Starting CDT fails because the required Update the we-site to the version re
variable specifies a newer version than client component version cannot be in quired by Client Terminal Component
what is available on the website. stalled. Version, or align the Client Terminal
Component Version with the website
version.
Use
Note
Procedure
MSI packages can be found in the Client Workstation Components folder of the installation directory.
● If a handset is used, install the driver: double-click the desired one of handset driver packages.
● If the agent will use video calls, double-click the wvp.msi package to install the video component.
● If the agent uses Online Monitoring or needs link to the third party telephony applications, double-click the
mctabuff.msi package.
Use
To use software 6.0 and 7.0 versions on the same workstation, install the 7.0 version terminal_proxy.msi
and then corresponding terminal_core components.
After initial installation, when a new version of the terminal_Core component is published, you can add the
new one and not remove the previous one.
Prerequisites
Procedure
1. Remove all version 6.0 client components , and also complete sets of 7.0 version client component
(installations of terminal.msi).
2. Install version 7.0 terminal_proxy.msi.
3. Install version 7.0 terminal_core.msi.
4. Install possible required handset drivers.
5. Install version 6.0 terminal_core.msi.
Defining the terminal version (if several 7.0 Core components are installed):
● The software uses the newest version of terminal_core.msi available for each main version, unless a
specific version is defined.
● To define the terminal version to be other than the newest one, start the Infrastructure Administrator,
choose Deployment mode, the Website VU installation, and Web Clients package parameter Client
Terminal Component Version, and enter the version number. The defined version is used in all client
workstations of the system.
Use
Note
The complete terminal package terminal.msi cannot be delivered with a group policy. Use specific
terminal components instead, see requirements for each application in the chapter Taking SAP Contact
Center End-User Applications into Use [page 10].
With the following procedure you enforce that the package is installed on all workstations of the organizational
unit when the client logs on:
Procedure
On the Active Directory server with the Active Directory Users and Computers tool:
Communication Desktop (CDT) can be run only on Microsoft Internet Explorer software. This software needs to
be installed on the workstation, and its security settings are set accordingly. See specific requirements in
section Taking End-User Applications into Use [page 10].
Note
Make sure that there are no 3rd party Internet Explorer add-ons, such as Google toolbar, nor other VoIP
solutions, such as Skype, installed on the workstation. These 3rd party software can block your SAP
Contact Center application, or affect the sound quality.
Note
Delete Internet Explorer temporary files regularly, and always when upgrading the system, with Tools
Internet options Delete . Accumulated temporary files may impair software functions, such as CDT
Diagnostic View.
Caution
Installing the Microsoft update MS14-037 (kb2962872, the update is currently included in IE11 installation
package) may cause malfunction in CDT. With the update, the iexplorer.exe process utilizes almost
100% of the processor capacity, and CDT becomes so slow that entering a number or other interactions in
user interface are impossible, or the UI crashes entirely.
NOTE: These updates are not installed automatically but you must fetch them from Microsoft support
page.
● To define the security settings with a group policy, see the section Configuring IE Security Settings with
Group Policies [page 29].
● To define individual security settings, see the section Configuring IE Security Settings on One Workstation
[page 29].
● Some settings in IE affect the appearance of applications, see the section Appearance of User Interfaces in
Internet Explorer [page 31].
● Some malware protection programs may prevent SAP Contact Center from running properly. For
workarounds, see the section Interference from Malware Protection Programs [page 32].
Use
Define the settings with the Group Policy Object Editor software on the Active Director server.
Note
The following procedure is supported at least on the Internet Explorer 6.0. Configure the IE 7.0, 8.0, 9.0 and
10.0 settings individually on each workstation, or follow the basic principle of the procedure below.
Procedure
Use
Note
Defining other settings may cause malfunction. For example, if the setting ActiveX controls and plug-ins:
Only allow approved domains to use ActiveX without prompt is enabled, CDT may not start.
Version Settings
Settings in Microsoft Windows and Internet Explorer affect the appearance of IE applications such as CDT,
Online Monitoring, and Reporting. If the UI does not appear as it should, for example, the screen is displayed
only partially, or the menu bar is missing, check the following or corresponding settings:
Some virus scanning or malware protecting programs, such as Microsoft Security Essentials (MSSE) or
Microsoft Forefront endpoint protection, may impair CDT or Convergence functions by reserving too much CPU
capacity. The following work-arounds have been found to be useful:
Note
File names and extensions were changed in SP07. In systems with older software than SP07, exclude
logfiles that start with CDT* and have extension .txt.
● When a type x.509 certificate, such as SAP Single Sign-On, is used for user authentication, see Using
Client Certificates for User Authentication [page 33]. For instructions how to acquire such a certificate,
see Installation Guide > Certificates.
● If a self-signed certificate (not issued by a public Certificate Authority, CA) is used for encrypting the client-
server connection, a CA certificate of the issuer must be installed on the client workstation as well, see
Providing Trusted Root for Server Certificate [page 35].
● To make sure that the certificate is installed on the workstation, see Checking Certificates Installed on
Workstation [page 34].
Use
SAP Contact Center supports using client certificates of the protocol X.509, such as SAP Single-Sign On
(SSO), for user authentication. If client certificates are used, they must be configured for the corresponding
servers, and also taken into use for each user account.
Note
When using Windows Server 2012 or later, the registry parameter SendTrustedIssuerList is
recommend to be set. See details from the SAP Note 2174821 . This is required at least if the client is
using several certificates, for example one for Lync.
Prerequisites
Each user requires a specific certificate. Acquire the certificates for real production use from a public CA.
Always follow the instructions of your own CA.
For test and demo use, you can follow the same procedure as for acquiring server certificates (see with the
following exceptions:
1. To make the .inf file when making the request, use MachineKeySet = FALSE and only OID =
1.3.6.1.5.5.7.3.2. Avoid using any special characters in subject text as they may not be supported
by the CA.
You can use the text below as an example:
[NewRequest]
Procedure
1. To take client certificate into use for Connection Server, select the check box Use Client Certificate in the IA
tool during installation. This enables using certificate for authentication in CDT and Convergence.
2. For Monitoring users, configure client certificates in the IIS Manager software on every server where a
virtual unit with Monitoring Web Clients software package is installed:
1. Start Internet Information Services (IIS) Manager
2. In the left pane, navigate to the site that corresponds to the virtual unit with Monitoring Web Clients
software package
3. In the central pane, open SSL Settings.
4. Ensure that Client certificates is having either Accept or Require checked.
5. Click Apply in the Actions pane
3. To apply client certificates for user accounts, define the certificate in the System Configurator application
User Management Users Certificates .
4. Make sure that appropriate client certificate is installed on the client workstation. Refer to the certificate
issuer for installation instructions.
Note
The server must accept the client certificate. The tools in the operating system accept automatically the
certificates issued by public CAs, but if you use a self-signed certificate, you must install the certificate of
the private CA on the server.
Use
If a server certificate, such as the one on Connection Server (CoS), is issued by a trusted public Certification
Authority (CA), the browser on the client workstation accepts the server certificate automatically. If the
certificate is created with a non-trusted CA, a corresponding certificate must be installed on each client
workstation. Ask for the CA certificate from the CA, or from your local certificate server administrator.
Procedure
Communication Desktop (CDT) can be started automatically at the user logon. See either Configuring Auto-
Start with Group Policies [page 36], or Configuring Auto-Start on One Workstation [page 36].
Note
If the MS Windows software is not installed on the C drive, change the location of Internet Explorer
executable iexplore.exe accordingly.
Use
You can configure the CDT application to start automatically when you log on into your workstation either by
Defining a Local Computer Policy, or Adding CDT to Startup Folder.
Procedure
Note
If the MS Windows software is not installed on the C drive, enter the location of the IE executable
instead of iexplore.exe accordingly.
5. Choose OK.
6. Choose more OK buttons until you can close the editor.
Note
● Make sure that the power saving setting of the operating system does not turn the USB device off when
it is inactive (see the settings MyComputer > Properties > Hardware > Device Manager >
Universal Serial Bus controllers > USB Root Hub-Properties > Power
Management).
● If the settings are available in BIOS, make sure the USB legacy settings are enabled, and the USB
mouse and keyboard are supported.
Audio Devices
Note
As of SP06, you can install all or some of the available device adaptors (terminal_HS_xxx.msi) on all
workstations. If you install more than one device adaptor, make sure you install also the
terminal_HS_USBHS.msi file for it loads and reads the handset.ini file and obtains information on
which adaptor to use with which device. In earlier versions we recommend installing only the adaptor
specific to the handset used.
The sound device, such as a headset, should be set automatically for the default audio device but if problems
occur, check the following settings:
For supported audio devices, see SAP Contact Center Compatibility List.
As of 1611, it is possible to use CDT and have Microsoft Lync open at the same time with Sennheiser BTD 800
USB dongle. This requires defining a registry setting. For more information, see the KBA http://
launchpad.support.sap.com/#/notes/2396218 .
Note
Using video camera requires that the wvp.msi package is installed on the workstation. Install it as other
terminal components either with a group policy or individually on each workstation, see Installation of
Client Components [page 19]. As of SP07, it can be installed automatically with auto-update.
Install the video camera according to the instructions of the camera manufacturer before starting the CDT
session. The supported camera models are listed in SAP Contact Center Compatibility List.
Administrators can enable client-side recording for a user, or a user template. When that is enabled, in CDT
user interface the recording button with an asterisk is displayed: Recording*, and the user can start and stop
recording with that.
The directory used for recording files is defined in the CDT, choose Tools Settings Phone General .
Following log files are saved on the client workstation in the current temporary %temp% path and registered in
the UTC time. You can view the files with a text editor.
Note
The prefix ContactCenter was added to log file names in SP07. When looking for log files of SP06 or older
versions, try BCM or no prefix.
By default, the log level is None (0), no log is written. If another log level is used, the log files are written for
each day. Writing logs slightly increases the client workstation CPU load, thus we recommend using low levels
in normal use, and reserving 4 and 5 to error situations only. The following levels are available:
The log level can be changed in the System Configurator for the entire system in General Settings Log
Level , or at the each client workstation in the following way:
You can also start CDT so that the URL includes a startup parameter that sets the log level. With this method,
you can set logging on right from the CDT start. For example, http://1.2.3.4:1080/cdt?
arg=loglevel=5. For more information on startup parameters, see the CDT help in Startup Parameters.
The log file name is logfile.json, and it is saved to the default download folder in the json format.
To define the log level and download log files, click View Settings Log Log Level and Download Log.
The client terminal process log follows the log level setting of the CDT, see CDT Logs [page 41]. By default, the
log level is None (0), no log is written. The other available levels are 1 = error, 2 = warning, 3 = info,
such as all CDT – Terminal messages, 4 = trace, and 5 = debug.
As of 1702, if there are any custom registry keys defined for audio devices, their name and value are printed to
log file if the logging level is Debugging.
● ContactCenter_Proxy_*: The log describes the communication between user interface and the ActiveX
proxy.
● ContactCenter_Terminal_* = Terminal log
By default, the terminal logs are saved for two days. The time can be configured in the System Configurator
User and Role Management CDT Personalization .
ClientCOM ActiveX component MCTABUF writes log of the ClientCOM interface implementation process, the
log file contains messages (commands and events) between ClientCOM servers and clients. The file name is
MCTABUFN.TXT where N is a number from 0 to 7. The log files are saved for a week, then the next file with same
number replaces the previous one.
The beginning of the log file contains the executable path, version and date. Log entries have the following
syntax:
● hh:mm:ss
There can also be Initialize and Destroy lines, where there are no sender or receiver, instead they tell
when a client or server has initialized itself with MCTABUFF, and when the connection has been deleted.
Log Levels
You can set the log level from the host application with the following line:
jQuery.sap.log.setLevel(jQuery.sap.log.Level.DEBUG);
Other possible log levels are (in ascending order, TRACE containing the highest level of information):
● jQuery.sap.log.Level.FATAL
● jQuery.sap.log.Level.ERROR
● jQuery.sap.log.Level.WARNING
● jQuery.sap.log.Level.INFO
● jQuery.sap.log.Level.DEBUG
● jQuery.sap.log.Level.TRACE
To set the log level of the browser to debug, add the following to the URL
?sap-ui-debug=true
Log is not written to a file by default. Instead it is collected to the internal log model. The current log
information can be saved to a file by requesting it from the host application.
Example
The following code creates a button which saves the current ECF log to a file when clicked. The log file
name is logfile.json, and it is saved to the default download folder in the json format.
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.