Client Installation Notes - WFM 7.2 v3.0
Client Installation Notes - WFM 7.2 v3.0
Subject always to any existing terms and conditions agreed between you
and NICE or any Affiliate with respect to the products which are the subject
matter of this document, neither NICE nor any of its Affiliates shall bear
any responsibility or liability to a client or to any person or entity with
respect to liability, loss or damage caused or alleged to be caused directly or
indirectly by any product supplied or any reliance placed on the content of
this document. This includes, but is not limited to, any interruption of service,
loss of business or anticipatory profits or consequential damage resulting
from the use or operation of any products supplied or the content of this
document. Information in this document is subject to change without notice
and does not represent a commitment on the part of NICE or any Affiliate.
All information included in this document, such as text, graphics, photos,
logos and images, is the exclusive property of NICE or in Affiliate and is
protected by United States and international copyright laws. Permission is
granted to use, view and photocopy (or print) materials from this document
only in connection with the products to which this document relates and
subject to the terms of license applicable to such products. Any other use,
copying, distribution, retransmission or modification of the information in this
document without the express prior written permission of NICE or an Affiliate
is strictly prohibited. In the event of any permitted copying, redistribution
or publication of copyrighted material, no changes in, or deletion of, author
attribution, trademark legend or copyright notice shall be made.
Products supplied may be protected by one or more of the US patents listed
at http://www.nice.com/Patents.
For the full list of trademarks of NICE and its Affiliates, visit
http://www.nice.com/nice-trademarks. All other marks used are the property
of their respective proprietors.
All contents of this document are: Copyright © 2019 NICE Ltd. All rights reserved.
For assistance, contact your local supplier or nearest NICE Customer Service
Center:
EMEA Region (Europe, United Kingdom Germany International
Middle East, Africa) Tel: +44-8707-22-4000 Tel: +49-(0)-69-97177-0 Headquarters-Israel
Tel: +972-9-775-3800 Fax: +44-8707-22-4500 Fax: Tel: +972-9-775-3100
+49-(0)-69-97177-200
Fax: +972-9-775-3000 APAC Region Fax: +972-9-775-3070
(Asia/Pacific) North America
email: [email protected] email: [email protected]
Tel: +852-8338-9818 Tel: 1-800-663-5601
The Americas Region Hong-Kong
Fax: +852-2802-1800 Fax: +201-356-2197
(North, Central, South Tel: +852-2598-3838
America) email: email:
[email protected] [email protected] Fax: +852-280-1800
Tel: 1-800-6423-611
Israel France
Fax: +720-264-4012
Tel: 09-775-3333 Tel: +33-(0)1-41-38-5000
email:
[email protected] Fax: 09-775-3000 Fax:
+33-(0)1-41-38-5001
email: [email protected]
1. Overview
Use these instructions to install and run the NICE Workforce Management (WFM)
Rich Client Platform (RCP) client software on a PC. Repeat these instructions each
time there is new or updated client software.
You can install one or more versions of the WFM client software on a PC. Install each
additional version in a different folder.
Important
The WFMData directory, which the WFM client uses for caching and logging,
is located in the user’s home directory. If the domain controller redirects
the user’s home directory (for example, to a network drive), the size of the
WFMData directory could significantly slow down the WFM client startup.
There are two possible solutions, both of which affect user roaming (users
who roam from one machine to another):
• Delete the WFMData directory when the WFM client startup becomes too
slow. The user roaming capability is lost when you delete (or rename) the
existing directory is deleted.
• Change the configuration file to keep the WFMData directory local. This
takes away the user roaming capability.
Release 7.2
6 NICE Ltd. Proprietary Client Installation Notes
Installing the WFM Client Software
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 7
Selecting the Language for the Client Installer Program
Release 7.2
8 NICE Ltd. Proprietary Client Installation Notes
Welcome
Welcome
The Client Installer guides you through installing the NICE WFM client software.
Figure 2 Welcome Step
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 9
Choose Install Folder
Release 7.2
10 NICE Ltd. Proprietary Client Installation Notes
Choose Install Folder
box appears indicating the target directory will be created. Click Cancel to
return to the Choose Install Folder step and change the install directory. Click
OK to continue to the next step of the Client Installer. Continue to WFM
Application Server, 12.
• If there is already a version of the client software installed at the location you
selected, this message appears when you click Next: The directory already
exists! Are you sure you want to install here and possibly overwrite existing
files?
In the message box, click Yes to continue and overwrite the existing version of
the client software, or click No to return to the Choose Install Folder step to
change the install directory and install to a new location.
– If you click Yes to continue and overwrite the existing version, the system
displays the WFM Application Server step of the Client Installer. Continue to
WFM Application Server, 12.
– If you change the install directory to install to a new location, a message
box appears indicating the target directory will be created. Click Cancel to
return to the Choose Install Folder step and change the install directory.
Click OK to continue to the next step of the Client Installer. Continue to
WFM Application Server, 12.
Note
If you reinstall (overwrite) an instance of the WFM client software on the
PC, the system saves the server configuration parameters in the Workforce
Management Configuration program.
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 11
WFM Application Server
To select the default server the WFM client software connects to:
(If you need help, contact your Systems Administrator.)
1. In the Enter Apache host name or IP address field, enter the hostname or IP
address of the server where Apache is running. If you are using a load balancer
enter the hostname or IP address of the load balancer. This server routes the
WFM client connection to the WFM application server.
The server IP address is a unique address that identifies the server. The IP
address you enter contains four integers from 0 to 255, separated with periods
(for example, 192.42.98.31).
You can only enter the name of a server if your PC has domain name services
(DNS) available.
2. Enter the Port number for the client software to use to connect to the server.
Use port number 80 for a non-SSL environment. Use port number 443 or other
SSL port for an SSL environment and select the SSL Enabled option. The port
number within the NICE Hosting environment is SSL port 443.
Release 7.2
12 NICE Ltd. Proprietary Client Installation Notes
Language Selection
3. Select the SSL Enabled option if you use SSL encryption. Clear this option if you
do not use SSL encryption. This option defaults to cleared.
Important
WFM client connections from outside a customer's internal network or
firewall are not supported.
4. Click Next to continue to the next step of the Client Installer.
5. Continue to Language Selection, 13.
Language Selection
Select the WFM client language in the Language Selection step of the Client Installer.
Figure 5 Language Selection Step
To select the language to use when running the WFM client software:
1. Select a language from the list of supported languages in this release of the
client software. For example, if you want to run the client software in English,
select English.
2. Click Next to continue to the next step of the Client Installer.
3. Continue to Business Type Selection, 14.
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 13
Business Type Selection
To select the business type terminology to use when running the WFM client software:
1. Select a business type option:
• Contact Center
• Back Office
• Retail
Note
If the WFM system does not yet support the selected language and
business type combination, the WFM client software uses the language
selected in Language Selection, 13 with the contact center business type.
2. Click Next to continue to the next step of the Client Installer.
3. Continue to Setup Shortcuts, 15.
Release 7.2
14 NICE Ltd. Proprietary Client Installation Notes
Setup Shortcuts
Setup Shortcuts
Add shortcuts in the Setup Shortcuts step of the Client Installer.
Figure 7 Setup Shortcuts Step
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 15
Setup Shortcuts
If you do not select the Create additional shortcuts on the desktop option
or the Create shortcuts in the Start-Menu option, you need to run the WFM
client application from the <install folder>\wfm folder (see Starting the NICE
WFM Client Software, 20).
3. Click Next to continue to the next step of the Client Installer.
4. Continue to Select Installation Packages, 17.
Release 7.2
16 NICE Ltd. Proprietary Client Installation Notes
Select Installation Packages
This step displays the required installation packages and the disk space required and
available. Please review the disk space information before continuing. Click Next to
install the NICE WFM client software on the PC.
Installation
Click Next on the Installation step after the installation completes. When you
complete the WFM client software installation on your PC, the Installation Finished
step displays:
• Installation has completed successfully.
• The uninstaller program location. To uninstall the WFM client software, see
Uninstalling the NICE WFM Client Software, 21.
• The Generate an automatic installation script button to use for a silent install
(see Creating a Silent Installation for the WFM Client Software, 26).
Click Done to quit the installer.
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 17
Canceling the Client Installer Program
Note
If you installed the WFM client software while another version of the WFM client
software was running, restart your computer to complete the installation.
Release 7.2
18 NICE Ltd. Proprietary Client Installation Notes
Configuring the NICE WFM Client to use a Proxy Server
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 19
Starting the NICE WFM Client Software
LDAP Authentication
If you use the LDAP Authentication feature, when a supervisor tries to log in, the
system authenticates the user ID and password against the customer's LDAP
directory, rather than validating against the WFM database.
If you use the LDAP Role Assignments feature, the system determines the roles
assigned to the user from the LDAP directory.
For more information, see the LDAP Authentication and LDAP Role Assignments
appendix in the Administrator Guide.
Release 7.2
20 NICE Ltd. Proprietary Client Installation Notes
Uninstalling the NICE WFM Client Software
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 21
Configure the WFM Server for the WFM Client Software
Release 7.2
22 NICE Ltd. Proprietary Client Installation Notes
Running the Workforce Management Configuration Program
Selected Server
In the Selected Server column, select the server you want the WFM client software
to connect. You can only select one server.
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 23
Running the Workforce Management Configuration Program
Port
The Port column displays the port number for the client software to use to connect
to each server. The default port number is 80. The default port number within the
NICE Hosting environment is 443. You can modify the port number for all servers
listed except the server specified as the Default Server.
Description
The Description column displays the description of each server. You can modify all
server descriptions listed, except the server specified as the Default Server.
Connect Icon
Click the connect icon ( ) to start the WFM client software and connect to the
server specified in the same row (a compatible version of the WFM software must be
running on the server you are connecting to).
When starting the client software:
• If you receive an error message that the client and server versions are
incompatible, you must upgrade your client software. Click OK to exit the
application and upgrade your client software.
• If you receive an informational message that the server and client versions are
different, but compatible, you can run the client software. Click No to close
the message box and not see the informational message the next time you log
in. Click Yes to close the message box and see the informational message the
next time you log in.
When you click the connect icon, the system saves any changes you made, closes
the dialog, and starts the WFM client software.
Release 7.2
24 NICE Ltd. Proprietary Client Installation Notes
Running the Workforce Management Configuration Program
Deleting Servers
You can delete all servers listed except the server specified as the Default Server.
To delete or restore rows in a spreadsheet:
1. Click Delete ( ) on each row you want to mark for deletion.
Each row you mark for deletion shows a strike-through line. On each row you
mark for deletion, the Delete button changes to the Restore button ( ).
2. Click Restore on each row to remove the strike-through line so the row is no
longer marked for deletion.
The system deletes rows you marked for deletion when you save changes.
3. Click Save to validate and save the changes to the database.
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 25
Creating a Silent Installation for the WFM Client Software
Release 7.2
26 NICE Ltd. Proprietary Client Installation Notes
Running the Silent Install
Note
You must define the AUTO_INSTALL environment
variable to tell the system where to look for the file.
For example, AUTO_INSTALL=C:\auto-install.xml or
AUTO_INSTALL=C:\<directory where file exists>\auto-install.xml.
You can do this in the Advanced tab of the System Properties dialog using
the Environment Variables button.
5. Copy the config.ini files from the installation path (for example, C:\Program
Files (x86)\NICE_WFM\client-configuration\configuration\config.ini
and C:\Program Files
(x86)\NICE_WFM\distribution-rules\configuration\config.ini) to the
same folders in the response file folder.
Release 7.2
Client Installation Notes NICE Ltd. Proprietary 27
Running the Silent Uninstall
1. Navigate to the parent folder of your install folder. For example, if your install
path is C:\Program Files (x86)\NICE_WFM, navigate to C:\Program Files
(x86).
2. Run the command:
echo %JAVA_HOME%
3. If the command returns a location, follow the steps in JAVA_HOME Exists, 28.
If the command returns %JAVA_HOME%, follow the steps in JAVA_HOME
does not Exist, 28.
JAVA_HOME Exists
If the echo %JAVA_HOME% command returned a location, follow the steps in
this section.
1. From the same folder you ran the echo command, run the command:
java -jar <install folder>\Uninstaller\uninstaller.jar -c —f
For example:
java -jar NICE_WFM\Uninstaller\uninstaller.jar -c —f
2. The system runs the WFM client uninstall program in silent mode.
The uninstaller removes the NICE WFM client software.
Release 7.2
28 NICE Ltd. Proprietary Client Installation Notes