You are on page 1of 62

Alcatel-Lucent OmniPCX

Enterprise
Free Desktop

Free Desktop version 3.0.1


– Windows Installation Guide

Alcatel-Lucent Services for Enterprise


All Rights Reserved © Alcatel-Lucent 2008
Legal notice

Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-
Lucent. All other trademarks are the property of their respective owners.

The information presented is subject to change without notice.

Alcatel-Lucent assumes no responsibility for inaccuracies contained herein.

Copyright © 2008 Alcatel-Lucent. All rights reserved.

All Rights Reserved © Alcatel-Lucent 2008 Page 2


Table of Content

1 INTRODUCTION ............................................................................6
1.1 Intended Readership............................................................................................................................. 6

1.2 Applicability Statement ....................................................................................................................... 6

1.3 Purpose .................................................................................................................................................... 6

1.4 Scope ........................................................................................................................................................ 6

1.5 Application Overview ........................................................................................................................... 7

1.6 How to use this document................................................................................................................... 7

1.7 Copyrights ............................................................................................................................................... 8

1.8 Related Documents ............................................................................................................................... 8

1.9 Licensing.................................................................................................................................................. 8

1.10 Customer Support.............................................................................................................................. 8

2 OVERVIEW....................................................................................9
2.1 The Application...................................................................................................................................... 9

2.2 This Manual ............................................................................................................................................. 9

2.3 Architecture ........................................................................................................................................... 9

3 ENVIRONMENT ........................................................................... 12

4 CONTENTS OF CD ROM .............................................................. 13

5 COPYRIGHTS .............................................................................. 14

6 PREPARING FOR INSTALLATION ................................................. 15


6.1 Compatibility Requirement for Inter-terminal Movement ........................................................ 15

6.2 Multi-Call Server configuration ........................................................................................................ 17

6.3 Interaction with Other Features...................................................................................................... 17


6.3.1 Functional compatibilities: ......................................................................................................... 17

All Rights Reserved © Alcatel-Lucent 2008 Page 3


6.3.2 Free Desktop and OmniTouch Unified Communication/4980................................................ 18
6.3.3 Alcatel–Lucent 8&9 Series Sets and Additional Key Modules................................................. 18

7 RECOMMENDED FREE DESKTOP ENVIRONMENT INSTALLATION . 19

8 OMNIPCX ENTERPRISE CONFIGURATION .................................... 20


8.1 General OmniPCX Enterprise Configuration.................................................................................. 20

9 ALCATEL XML API OR UC INSTALLATION ................................... 21

10 NETWORK ARCHITECTURE OVERVIEW ....................................... 22


10.1 Network Architecture..................................................................................................................... 22

10.2 Testing your Network Architecture ............................................................................................ 22

10.3 Free Desktop Server Prerequisites ............................................................................................. 23

11 FREE DESKTOP ENVIRONMENT INSTALLATION........................... 24


11.1 Java 2 SDK 1.5.0_10 Installation ................................................................................................. 24

11.2 Tomcat 5.0.28 Installation ............................................................................................................ 32

11.3 Free Desktop Components Installation....................................................................................... 39

12 INSTALLATION CHECKS .............................................................. 47


12.1 Tomcat 5.0.28 Test......................................................................................................................... 47

12.2 FreeDesktop Server Test ............................................................................................................... 48

12.3 FreeDesktop Web Interface Test ................................................................................................. 48

12.4 IP Touch Interface Setup Test ...................................................................................................... 49

13 CONFIGURATION ........................................................................ 51
13.1 Presentation Server Configuration.............................................................................................. 51

13.2 OmniPCX Enterprise Configuration for Free Desktop Interface........................................... 54

14 UNINSTALLING ........................................................................... 57
14.1 Free Desktop Environment Uninstalling..................................................................................... 57

All Rights Reserved © Alcatel-Lucent 2008 Page 4


14.2 Free Desktop Web Interface Uninstalling .................................................................................. 57

14.3 Complete Free Desktop IP-Touch Interface Uninstalling ....................................................... 58

15 APPENDIX................................................................................... 60
15.1 Table of Figures ............................................................................................................................... 60

All Rights Reserved © Alcatel-Lucent 2008 Page 5


1 Introduction
1.1 Intended Readership

This manual targets System Administrator who also does networking. This is not
relevant to the user of this application

1.2 Applicability Statement

This manual applies to installation and configuration of the application: Free


Desktop version 3.0.1 and its related software in multiple servers and clients. This
does not cover actual use of this application.

1.3 Purpose

This guide explains:

• The hardware and software environment that the installation of this


application requires.
• The method of installing Free Desktop Environment version 3.0.1.
• The method of installing related software on other servers.
• Configuration of Free Desktop Environment version 3.0.1.
• Configuration of related software.

This manual targets at the System Administrator, and provides him with all
necessary information to complete the above tasks.

1.4 Scope

This manual covers

• Hardware requirements

• Software requirements

• Method of installing Free Desktop Environment version 3.0.1.

• Method of configuring Free Desktop Environment version 3.0.1.

• Method of installing related software

• Method of configuring related software

• Checking if the installation is done all right

• Uninstalling the Free Desktop Server Environment version 3.0.1.

All Rights Reserved © Alcatel-Lucent 2008 Page 6


1.5 Application Overview

You will have to install the application: Free Desktop Environment in a separate
server. Free Desktop Environment is supported by one or more OXE Server/s and
XML Server/s. These supporting servers are installed with software that supports
the Free Desktop Server. After installation, they should be configured as needed.
The OXE servers are connected to different telephone terminals. The Free Desktop
Server enables movement of users among different terminals within the network.
When one user moves to another terminal, he can use that terminal as his own – his
incoming calls would land up in this new terminal.

To enable this mobility, the telephone terminals will have to be in accordance with
the specifications.

1.6 How to use this document

This manual explains the complete installation process in sequence. So, a


sequential reading of this manual and executing the given tasks could make the task
easy.

The installation process is conveniently explained under following heads:

• Overview
• Environment
• Contents of CD Rom
• Preparing For Installation
• Recommended Free Desktop Environment Installation
• Network Architecture Overview
• Alcatel XML API or UC Installation
• OmniPCX Enterprise Configuration
• Free Desktop Environment Installation
• Installation Checks
• Configuration
• Uninstalling

The above categorization could help you to use this manual for quick reference –
you can get what you want, more easily. You can access the required part of this
manual by using the Table of Contents given at the beginning of this manual. The
entries in this list are hyper-linked. User Ctrl+Click on the line to move to that part
of the manual.

For layouts, diagrams are provided.

As much as possible and based on relevance, screenshots are provided at


appropriate places for you to visualize the process. As required, some screenshots
are provided with brief explanation in the screen itself.

All Rights Reserved © Alcatel-Lucent 2008 Page 7


If you prefer to access different parts of this manual based on screenshots, then you
can use the Table of Figures given at the end of this manual. The entries given
there are hyper-linked to move you to the screenshot, on which you can Ctrl+Click.

1.7 Copyrights

This product is based on software developed by Microsoft.


Copyright (C). All rights reserved.
This document gives product names, which can be trademarks, all of them
recognized as such.

1.8 Related Documents

Free Desktop – Administration Guide

Free Desktop - User Guide

1.9 Licensing

Each Free Desktop Server 3.x required a FlexLM license: FREEDESKTOP version 1.0.
Each Free Desktop User 3.x required a FlexLM license: FREEDESKTOPUSER version
1.0.
IP Touch Mobile Solution required FlexLM licenses for all the IP Touch users: MY IP
TOUCH BASIC SERVICES.

1.10 Customer Support

Please contact your system administrator or Alcatel-Lucent Business Partner for


support

All Rights Reserved © Alcatel-Lucent 2008 Page 8


2 Overview

2.1 The Application


This application enables portability of phone terminals in a corporate network. User
of one terminal can move to another terminal in the network. He can use this new
terminal as his own, that it is initialized with his original number. Incoming calls to
his original terminal will land up in this new terminal. In the new terminal, the user
will have to use his original directory name, and his original number. In this
manner, this application makes movement of personnel within the network, most
convenient.

2.2 This Manual


This document is an installation guide. It describes the minimum procedures
required to install the Alcatel Free Desktop Environment (FDE) software.

Further information is provided in the Readme.txt and ReleaseNotes.txt files,


available at the root and under each component's sub-directories of the Free
Desktop Environment CDROM.

2.3 Architecture
Below is a sample architecture for the Free Desktop:
Commentaire [kbl1] : Chan
g “API Release 4.0” in “API
Release 5.0”

FIGURE 1 - Free Desktop Architecture

In the above layout, a user of one OXE server can move to a terminal under another
OXE server. He can use it just like his earlier terminal. His incoming calls reach the
new terminal, and not the old one.

All Rights Reserved © Alcatel-Lucent 2008 Page 9


FIGURE 2 - Sequence diagram: Logon - IP Touch Interface

All Rights Reserved © Alcatel-Lucent 2008 Page 10


FIGURE 3 - Sequence diagram: Web Interface

Installing Free Desktop involves installation and configuration of the application in:

1. OXE Server/s
2. XML Server/s
3. Free Desktop Server

All Rights Reserved © Alcatel-Lucent 2008 Page 11


3 Environment
Installation of Free Desktop application requires specific hardware and software.
These extend from main servers to the terminals of users. The following table gives
a consolidated list of those requirements

Free Desktop Environment Release 3.0.1

Operating systems Microsoft Windows® 2003 SP1

Version 8.0, 9.0


OmniPCX Enterprise
The Alarm lock (47)

4010, 4010 + TSC IP, 4020, 4022, 4035, 4037,


Supported sets 4008, 4018, 4019, 4028, 4029, 4038, 4039, 4068, IP
Desktop Softphone

XML API Release 5.1 and higher or


corresponding UC, with FREEDESKTOP license
Alcatel XML API Framework enabled.
or
Alcatel Unified Communication (UC) Requires My IP-Touch XML Basic Services 10 ext.
pack (depending on the total amount of IP-
Touch sets - only for IP-Touch Interface)

Presentation Server (PRS) Since 1.1 (Only with IP-Touch Interface)

Java version Java 2 SDK 1.5.0_10

Application Server Tomcat 5.0.28

All Rights Reserved © Alcatel-Lucent 2008 Page 12


4 Contents of CD ROM
Free Desktop Environment Installation Pack comes to you with a CD for installation
purposes. Its contents are:

I. Free Desktop Environment for Linux OS :

a. Free Desktop Environment installer


b. Free Desktop High Availability installer

II. Free Desktop Environment for Windows OS :

a. Free Desktop Environment installer

III. External Applications

a. Java 2 Software Development Kit (1.5.0_10)


b. Application Server (Tomcat 5.0.28)

IV. Guides

a. This installation guide


b. Other guides

V. README.txt file.

All Rights Reserved © Alcatel-Lucent 2008 Page 13


5 Copyrights
This product includes software developed by Apache Software.

Foundation: http://www/apache.org/

Copyright (C) 1995-2000 University College London. All rights reserved.

Expat: Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd and
Clark Cooper

Other product and company names mentioned herein may be the trademarks of
their respective owners.

All Rights Reserved © Alcatel-Lucent 2008 Page 14


6 Preparing for Installation

6.1 Compatibility Requirement for Inter-terminal Movement


For moving purposes, the user can use either

• Free Desktop IP Touch Interface or


• Free Desktop Web Interface or
• Both

Free Desktop is available for users provided with following types of telephone sets:

• 8 & 9 series: 4008, 4018, 4019, 4028, 4029, 4038, 4039 and 4068,
IPDESKTOP SOFTPHONE
• Reflexes/e-Reflexes: 4010, 4010 IP, 4020, 4022, 4035, 4037

The following table gives details of Application availability in telephone sets:

Phone Free Desktop IP Free Desktop


Types Touch Interface WEB Interface

4010 
4010 IP 
4020 
4022 
4035 
4037 
4018 
4019 
4028  
4029 
4038  
4039 
4068  
IPDSP  
FIGURE 4 - Application availability

All Rights Reserved © Alcatel-Lucent 2008 Page 15


Switching a telephone set for another is possible, provided phone sets are
compatible. The following table shows the matrix of phone set compatibility.

FIGURE 5 - Phone set Compatibility

All Rights Reserved © Alcatel-Lucent 2008 Page 16


6.2 Multi-Call Server configuration
If Free Desktop users are required to move among several nodes, then:

• Alcatel-Lucent strongly recommends having the same release and patching


on each node

• The inter-system diffusion mechanism must be activated

• The dialing plan must be homogenous between the different nodes

• The definition of Classes of Services, entities and discrimination must be


compatible/homogeneous on each node

• When users change node, their taxation tickets are generated and allocated
to this new reporting node.

6.3 Interaction with Other Features


6.3.1 Functional compatibilities:

This function of mobility is not available for:

• Sets which belong to a call centre group

• Sets using additional key modules (except for key modules detailed: §
Alcatel–Lucent 8&9 Series Sets and Additional Key Modules)

• Sets which belong to a group of sets (available when user moves within the
same Call Server)

• Sets using a data , analog or S0 interface

• Analog, DECT/PWT, Wifi or SIP sets

• Sets using the twin-set feature (available when user moves within the same
Call Server)

• Sets configured on forwarding at night or general ringing

• Sets which belong to an MLA (MultiLine Appearance) group

Free Desktop users cannot monitor other sets, or use or be used by applications
based on CSTA, CTI and SIP protocols.

All Rights Reserved © Alcatel-Lucent 2008 Page 17


6.3.2 Free Desktop and OmniTouch Unified Communication/4980

o Nomadic mode: This feature is not available when a Free Desktop user is
logged off.

o My Phone: No interaction when a user moves in a PBX network managed by a


single XML API / UC.

My Phone services are suspended when a user moves on a PBX that is not
managed by his original XML API / UC. The user retrieves all My Phone services
when he moves back on a PBX managed by his original XML API / UC.

o My Assistant: Free Desktop detects if a user has activated My Assistant and


does not modify the immediate forward on the routing point if there is one.

o My Messaging & My Teamwork: No interaction.

6.3.3 Alcatel–Lucent 8&9 Series Sets and Additional Key Modules

On 8&9 series sets, namely: 4028, 4029, 4038, 4039, 4068 and IP Desktop Softphone,
four types of additional key module(s) can be connected.

The available additional key modules are:

• Additional module with 10 keys

• Additional module with 20 keys

• Additional module with 40 keys

• Smart Display additional module with 14 keys

The Smart Display additional module with 14 keys is not compatible with
Free Desktop. With the 3 other additional modules, a Free Desktop user
can log on another phone set but:

• If the target phone set is equipped with an identical additional module, the
user can use the target phone set as his/her own set

• If the target phone set is not equipped with an additional module or if this
additional module is different, additional keys are not available

• When users log on their own phone set, they retrieve the use of their
module additional keys

All Rights Reserved © Alcatel-Lucent 2008 Page 18


7 Recommended Free Desktop Environment installation
The Free Desktop Environment standard offer consists of 1 installer for 2
applications :

• Free Desktop Environment (Server/Web Interface/IP Touch Interface) :


service started automatically

• Free Desktop SNMP Agent : service needing to be start manually by the


administrator

Installation Process:

The following figure explains the installation process. You will have to install and
configure the software in the sequence given :

OXE Server

1. Configure OXE

XML Server (OS RHEL 4 Update 5)

2. Configure XML

3. Configure Presentation Server

4. Configure FlexLM Server

5. Configure XML Web Services

Free Desktop Server

6. Install Free Desktop Environment

All Rights Reserved © Alcatel-Lucent 2008 Page 19


8 OmniPCX Enterprise Configuration

Goals: To check if the OmniPCX Enterprise(s) is(are) correctly configured


for the Free Desktop feature. To configure future Free Desktop
users

Scenario: You are connected to your OmniPCX Enterprise network. You know
exactly:

- Which users to configure


- Their level of use (Free Desktop rights)
- The number of temporary directory numbers on each nodes

Outcome: The OmniPCX Enterprise will be ready for Free Desktop operations.

Time: According to:

- The number of nodes


- The number of users

The OmniPCX Enterprise(s) configuration must be complete and all subscribers must
be created and assigned to their set. Broadcast must be enabled (even when there
is only one node).

8.1 General OmniPCX Enterprise Configuration


The following checks must be performed for each node of your network. To check
the broadcast is enabled:

1. Connect to the OmniPCX Enterprise using Telnet

2. Enter login and password

3. When prompted, enter mao -a

4. If on the first line you read BROADCAST is off, enter mao +br to enable
broadcast. The prompt must read BROADCAST is on

5. The last line must read Synchronization 4400-47xx is on. If not:

a. Access the OmniPCX Enterprise configuration tool


b. Select System
c. Review/modify the following attribute:
47xx directory - 4400 Synchro Select True
d. Confirm your entries

All Rights Reserved © Alcatel-Lucent 2008 Page 20


9 Alactel XML API or UC Installation

Goal: To install and configure the API Framework for Free Desktop Web Service
for operation

Scenario: Install or configure the API for Free Desktop use. This section of this
document describes the recommended configuration

Outcome: The Alcatel XML API Framework will be installed and configured for Free
Desktop. The mandatory information to install Free Desktop will be listed.

Time: According to your configuration

Please refer to the installation guide of the product you install. Free Desktop Web
Service uses the following components:

• Presentation Server (if you install the Free Desktop IP Touch Interface)
• FlexLM Server
• XML Web Services

To be able to move among several Call Servers, you have to configure the Open
Telephony Server (OTS) for each Call Server created in the XML API. At Free
Desktop purchase, the FREEDESKTOP license has been automatically generated in
the Alcatel XML API or UC licenses. The Free Desktop Web Service application
checks this license via the FLEXlm Server installed with the Alcatel XML API or UC.

The following parameters are requested at Free Desktop Server configuration:

Hostname (or IP address) of the computer


FLEXlm server host
where the FLEXlm Server is installed.

FLEXlm server port Port number. Generally 27000.

All Rights Reserved © Alcatel-Lucent 2008 Page 21


10 Network Architecture Overview

Goal: Prepare your network architecture in order to install Free Desktop

Scenario: Before installing Free Desktop, you need to know whether your hardware
installation is compatible with Free Desktop, and whether the requested
components are correctly installed

Outcome: You will be ready to start Free Desktop installation

Time: According to your configuration

10.1 Network Architecture


The Alcatel XML API Framework can run under Linux Red Hat 4.0 Enterprise. The
Free Desktop Server must run under Windows® 2003 SP1 Server in this release.
Please consult the readme.txt file on the Free Desktop Environment to find out
about the last updates.

XML API or UC. Components used :

• FlexLM Server

• Presentation Server

• XML Web Services

XML API or UC server and Free Desktop server must be able to communicate through
their hostname.

10.2 Testing your Network Architecture


Check all connections (especially if your installation is different from the figures
above) and more particularly connections between:

- The Free Desktop Server machine and:

• The FLEXlm Server (through hostnames)

• The OmniPCX Enterprise network (recommended)

• The Presentation Server

Example:

All Rights Reserved © Alcatel-Lucent 2008 Page 22


To check the connection between two computers, for example computer A, named:
hostnameA with 172.25.163.80 as IP address, and computer B, named hostnameB
with 172.25.163.180 as IP address:

1. On A, click start to open your Start Menu

2. Click Run, this will open a dialog box that allows you to type in a command

3. Type in cmd and click OK. This opens a command window

4. Type in ping hostNameB to test the hostname

5. Type in ping 172.25.163.180 to test the IP address

6. The system provides different responses, such as:

« Reply from hostNameB : octets=32 temps<1ms TTL=128 »

If an error displays indicating that hostNameB (or 172.25.163.180) was not found,
then there is a network problem. Check your network configuration.

10.3 Free Desktop Server Prerequisites


• You must be logged on with Administrator privileges in order to install the
software.

• A minimum space of 1Go is required and 2Go RAM for Free Desktop

• It is recommended to start with a freshly installed Windows Server.


Otherwise, some interactions can occur, such as a port already in use or
blocked through firewall.

All Rights Reserved © Alcatel-Lucent 2008 Page 23


11 Free Desktop Environment Installation

Goals: This section describes how to install all Free Desktop Environment
components

Scenario: You are on the machine where Free Desktop Environment is to be installed

Outcome: The Free Desktop Environment will be installed on your machine

Time: About 25 minutes.

11.1 Java 2 SDK 1.5.0_10 Installation

Goal: To check that Java 2 SDK 1.5.0_10 is installed on the machine where Free
Desktop will be installed. If not, install this component.

Scenario: You are on the machine where the Free Desktop Environment will be
installed.

Outcome: JDK 1.5.0 will be installed on your Free Desktop Server.

Time: 15 minutes.

Check whether Java 2 SDK 1.5.0_10 is installed:

1. Go to Start  Control Panel  Add  Remove Programs

2. Verify that J2SE Development Kit 5.0 update 6 is in the list. (The number of
update can be higher than 6)

If this environment is not installed:

1. Launch the jdk-1_5_0_10-windows-i586-p.exe application available on


External Applications folder on the Free Desktop Environment CD-ROM.
This triggers the screens given below. Below each screenshot, you can find
its explanation.

All Rights Reserved © Alcatel-Lucent 2008 Page 24


SCREENSHOT 6 - Java 2 SDK Installation – Welcome Screen

2. This is an introductory screen. It would automatically change

SCREENSHOT 7 - Windows Installer Configuration - Progress bar

3. Progress bar indicating configuration of Windows installer. This also will


automatically change, once the configuration is over.

SCREENSHOT 8 - Commencement of Installation

4. Commencement of installation process

All Rights Reserved © Alcatel-Lucent 2008 Page 25


SCREENSHOT 9 - License Agreement

5. This is the license agreement for you to read and accept. By default,
second option is selected. You will have to select the first option (I accept
. . .). Only then the installation could proceed.

All Rights Reserved © Alcatel-Lucent 2008 Page 26


SCREENSHOT 10 - J2SE Development Kit component selection & installation path

6. The enclosed box lists different folders that contain J2SE Development Kit
5.0. You can click on any of them to see the files in them. In their
expanded form, you can select/deselect any of the components. It is
recommended that you leave them to default.

7. Below the box, you can find: Install to. Below it, you can find the folder
where these components will be installed. If you prefer to install them in
another directory, you can click on the Change button given at right.

All Rights Reserved © Alcatel-Lucent 2008 Page 27


SCREENSHOT 11 - Installation progress bar

8. This screen shows the progress bar indicating installation progress. Once
the installation completes, it will move to next screen.

All Rights Reserved © Alcatel-Lucent 2008 Page 28


SCREENSHOT 12 - J2SE Runtime Environment component selection & installation path

9. The enclosed box lists different folders that contain J2SE Runtime
Environment with European languages. You can click on any of them to see
the files in them. In their expanded form, you can select/deselect any of
the components. It is recommended that you leave them to default.

10. Below the box, you can find: Install to. Below it, you can find the folder
where these components will be installed. If you prefer to install them in
another directory, you can click on the Change button given at right.

All Rights Reserved © Alcatel-Lucent 2008 Page 29


SCREENSHOT 13 - Select Browser Registration

11. This page gives you the option to register with the browser of your choice.
By default, all given browsers are selected. It is suggested that you leave
it to default. Then click Next.

All Rights Reserved © Alcatel-Lucent 2008 Page 30


SCREENSHOT 14 - Installation progress bar

12. Progress bar showing the installation progress.

All Rights Reserved © Alcatel-Lucent 2008 Page 31


SCREENSHOT 15 - Installation complete

13. Now the installation process is complete. Click on Finish to close this
window.

If you are requested to reboot the computer, reboot the computer. After the
reboot phase (if necessary), proceed as explained below.

11.2 Tomcat 5.0.28 Installation

Goal: To install an application server to host the Free Desktop


components. Tomcat 5.0.28 is the only version supported

Scenario: You are on the machine where Free Desktop will be installed.

Java 2 SDK 1.5.0_10 is already installed on it.

Outcome: Tomcat 5.0.28 will be installed and ready to host Free Desktop.

You will know on which HTTP port Free Desktop Web Service will
be available.

Time: 15 minutes.

1. Launch the jakarta-tomcat-5.0.28.exe application available on External


Applications folder on the Free Desktop Environment CD-ROM. The
installation process displays the screens given below. Below each
screenshot, you can find its explanation.

All Rights Reserved © Alcatel-Lucent 2008 Page 32


SCREENSHOT 16 - Apache Tomcat installation – Welcome Screen

2. Apache Tomcat installation – Welcome screen. Click Next to continue.

All Rights Reserved © Alcatel-Lucent 2008 Page 33


SCREENSHOT 17 - License Agreement

3. This screen displays license agreement. You can scroll down the screen to
view the full text. If you agree to it, click on the I Agree button.
Otherwise, you cannot continue with the installation.

SCREENSHOT 18 - Select: Install type and optional components

4. Against: Select the type of install, different types of installation are


listed. You can select your preference there. Suggested type is: Normal
(default).

5. In the box below, you can find a list of optional components. Select all the
components given (default).

6. Once you are finished with the entries, click Next.

All Rights Reserved © Alcatel-Lucent 2008 Page 34


SCREENSHOT 19 - Select: Install location

7. This screen displays the default destination folder. You can use the
Browse button at right to change this folder, if desired. Once done, click
Next.

All Rights Reserved © Alcatel-Lucent 2008 Page 35


SCREENSHOT 20 - Configuration page

8. The port will be requested for during the rest of installation

9. The password is not mandatory; it is used only if you want to manage


Tomcat. There is no interaction with Free Desktop.

10. Once finished, click Next.

All Rights Reserved © Alcatel-Lucent 2008 Page 36


SCREENSHOT 21 - Path of Java Virtual Machine

11. This is Java Virtual Machine installation folder selection window. You can
use the button at right to change this folder setting.

12. Select the Java virtual machine directory. Select the JDK not the JRE!!!

13. Typically, the installer automatically detects this directory. If not, select it
manually

14. Click Install.

All Rights Reserved © Alcatel-Lucent 2008 Page 37


SCREENSHOT 22 - Installation progress bar

15. Installation progress bar. Wait till the installation process completes. This
would take several minutes.

All Rights Reserved © Alcatel-Lucent 2008 Page 38


SCREENSHOT 23 - Installation complete

16. Now the installation process is complete. In this screen, ensure that Run
Apache Tomcat is ticked. To install Free Desktop, you will have to keep
Tomcat running.

17. Click Finish to close this screen.

18. If the system tray, you can find the following icon. This indicates that
Tomcat is running.

19. Sometimes, the Tomcat Windows® service is not configured to start


automatically at server startup. Set the Tomcat service startup type to
Automatic

11.3 Free Desktop Components Installation


1. Before installing Free Desktop components, please install Java 2 SDK
1.5.0_10 and then tomcat 5.0.28 applications available on External
Applications folder

All Rights Reserved © Alcatel-Lucent 2008 Page 39


2. Insert the Free Desktop Environment CD-ROM. The installation process
should start automatically. If it doesn't, launch the setup.exe file. The
installation process displays the screens given below. Below each
screenshot, you can find its explanation.

SCREENSHOT 24 - Free Desktop Installation – Welcome screen

3. This is Free Desktop Installation Welcome screen. Click Next to continue.

All Rights Reserved © Alcatel-Lucent 2008 Page 40


SCREENSHOT 25 - License Agreement

4. This screen shows the license agreement. Scroll page to view the complete
text. Click on the “I accept . . .” radio button. Otherwise, the installation
will abort.

All Rights Reserved © Alcatel-Lucent 2008 Page 41


SCREENSHOT 26 - Selection of installation folder

5. This page displays the folder where installation files will be copied, by
default. If you need to change this folder, you can use the Browse button
at right.

6. Click Next.

All Rights Reserved © Alcatel-Lucent 2008 Page 42


SCREENSHOT 27 - Location of Free Desktop Database

7. This page displays the default path for Free Desktop Database Directory. If
you need to change this, use the Browse button at right.

8. Click Next.

All Rights Reserved © Alcatel-Lucent 2008 Page 43


SCREENSHOT 28 - Tomcat port specification

9. The installer searches for Tomcat home path where the application will be
hosted. This path is displayed above, which you cannot change.

10. In the Tomcat port field, enter the Tomcat port number. By default it is:
8080.

11. Click Install.

All Rights Reserved © Alcatel-Lucent 2008 Page 44


SCREENSHOT 29 - Installation progress bar

12. Now the installation process has began. The screen above displays the
progress of installation process. This could take several minutes.

All Rights Reserved © Alcatel-Lucent 2008 Page 45


SCREENSHOT 30 - Installation complete

13. Now the installation is complete. Click Finish to close the screen.

14. If you are prompted to reboot the computer, and if there is no other Free
Desktop component to be installed at this stage, do so. Otherwise, you
need not reboot.

When the Free Desktop sends an error message such as UNAVAILABLE_SERVICE, it


means that the server is not completely started. Service start can take up to several
minutes after installation. Once you are sure the Free Desktop is well installed and
started, you will have to configure it. Refer to “Free Desktop Administration guide”
to do that.

All Rights Reserved © Alcatel-Lucent 2008 Page 46


12 Installation Checks

12.1 Tomcat 5.0.28 Test

Goal: To test if Tomcat 5.0.28 used by the Free Desktop Environment is


running.

Scenario: Installation is over and no error has occurred

Outcome: You will know if Tomcat 5.0.28 is correctly installed and is running.
Then you will be able to check Free Desktop components installation

Time: 1 minute

To start or stop the Tomcat Server, start or stop the Tomcat Service Manager

SCREENSHOT 31 - Tomcat Service Manager

1. Check the description field to ensure you are monitoring the right Tomcat.

2. Check that Tomcat is started in the Status column. If not, start it by


clicking in the corresponding cell.

3. If the Startup Type is not Automatic the Tomcat Server will not restart
automatically when the server restarts (double click the line to modify it).

All Rights Reserved © Alcatel-Lucent 2008 Page 47


12.2 FreeDesktop Server Test

Goal: To test if the Free Desktop Web Service is available.

Scenario: Installation is over and no error has occurred.

Outcome: You will know if the Web Service is correctly installed and ready to
start.

Time: 1 minute.

To use Web Service, the URL where Free Desktop Web Service is available must be
configured in client applications. The Free Desktop Web Service's URL is as follows:

http://[hostname]:[HTTP_port]/freedesktop/

Where [hostname] is the name of the machine on which Free Desktop Web Service
runs, and [HTTP_port] is the HTTP port number configured in Tomcat (typically:
8080). Test this URL to know if the Web Service is available, using following steps:

1. Start your favorite web browser (e.g. Internet Explorer, Mozilla, Firefox)

2. Enter the above URL with the correct hostname and HTTP port number.
You should get the login page of FreeDesktop Web Service Configuration. If
you get an error page, go to the Trouble shooting section of your
Administration guide

12.3 FreeDesktop Web Interface Test

Goal: To check if FDE Web Interface has been correctly installed.

Scenario: Once the application has been installed, check setup is correct.

Outcome: The FDE Web Interface will run properly on your machine.

Time: 5 minutes.

After FDE Web Interface setup: go to:

Start  All Programs  Free Desktop  Web Interface

• Select FDE Web Interface to use the application.

• Select Uninstaller to launch the FDE Web Interface Uninstall Wizard.

All Rights Reserved © Alcatel-Lucent 2008 Page 48


In the FDE Web Interface setup directory, several directories have been installed in
the main directory, by default:

C:\Program Files\Alcatel\FreeDesktop\WebInterface

The _uninst folder contains the uninstaller. The log folder contains traces (logs) of
the application. C:\Program Files\Alcatel\FreeDesktop\Data\log

The following directory contains documentation.

C:\Program Files\Alcatel\FreeDesktop\Documentation

12.4 IP Touch Interface Setup Test

Goal: To check if FDE IP Touch Interface has been correctly installed

Scenario: Once the application has been installed, check setup results.

Outcome: FDE IP-Touch Interface will run properly on your machine.

Time: 5 minutes

After the FDE IP Touch Interface setup: go to

Start  All Programs  Free Desktop  IP-Touch Interface

• - Select Check setup to test if setup was successful.

• - Select Is running to see if the application is running.

• - Select Uninstaller to launch the FDE Web Interface Uninstall Wizard.

In the FDE Web Interface setup directory, several directories have been installed in
the main directory, by default :

C:\Program Files\Alcatel\FreeDesktop\IPTouchInterface

The _uninst folder contains the uninstaller. The logs folder contains traces (logs) of
the application.

The following directory contains documentation.

C:\Program Files\Alcatel\FreeDesktop\Documentation

To check if the setup was successful: go to

Start  All Programs  Free Desktop  IP-Touch Interface  Check setup

All Rights Reserved © Alcatel-Lucent 2008 Page 49


A page as in the figure below is displayed if setup was successful. If not, verify that
the Tomcat service is running and that the URL points to the FDE IP-Touch Interface
Server and Tomcat port.

SCREENSHOT 32 - IP-Touch Interface Start Page

All Rights Reserved © Alcatel-Lucent 2008 Page 50


13 Configuration

13.1 Presentation Server Configuration

Goal: To declare Free Desktop IP-Touch Interface on the Presentation


Server.

Scenario: The Free Desktop IP-Touch Interface is installed. The application


server (Tomcat) is running.

Outcome: You will have a Presentation Server where the Free Desktop IP-
Touch Interface is declared.

Time: 5 minutes

To declare FDE IP-Touch Interface in the Presentation Server:

1. Log on as admin on the Xml Api server (or UC), via its web interface; click on
Services in the menu to the left of the page. A configuration page is displayed.

SCREENSHOT 33 - XML API Service Configuration Page

All Rights Reserved © Alcatel-Lucent 2008 Page 51


2. In the list of services, locate the service whose entity type is Presentation Server
and click the icon in the Action column

3. A PRS Application Management – Presentation Server Global Parameters


configuration page is displayed. If there is a proxy between the Presentation
Server and the Free Desktop Server, you can configure it here.

4. Click Next. A second administration page, where IP-Touch applications are


listed (if they exist); is displayed

SCREENSHOT 34 - List of IP Touch Application Example Window

5. Find a free Index in this list (this value must be higher than 0)

6. Click Create. Another configuration page is displayed

All Rights Reserved © Alcatel-Lucent 2008 Page 52


SCREENSHOT 35 - IP-Touch Application Creation Example

7. Fill the 3 mandatory fields:

- “Index”: put here the free index value (higher than 0) you found before.

- “Identifier”: this is 4 letters identifier (for example: “FDEI”). It will be


used to identify the Free Desktop application on the PBX during the next
OXE configuration.

- “URL registration”: this is the address where the IPTouch application can
be reached on the Free Desktop Server. This address is like :

http://{FD-SRV-HOST}:{FD-SRV-TOMCAT-PORT}/iptouchinterface/Register

where:

{FD-SRV-HOST} must be replaced by the IP address or the hostname of the Free


Desktop Server.

{FD-SRV-TOMCAT-PORT} must be replaced by the Tomcat 5.0.28 port you have


installed before.

For example, the following URL is valid:

All Rights Reserved © Alcatel-Lucent 2008 Page 53


http://192.168.101.17:8080/iptouchinterface/Register

Be careful with the upper cases. Keep the other ones with their default value.

8. Click Create. You are brought back to the list of application page. Your new
application is added to the list

9. Click Next. Another page is displayed

10. Click Finish

13.2 OmniPCX Enterprise Configuration for Free Desktop Interface

Goal: To configure the OmniPCX Enterprise in order to display the Free


Desktop IP-Touch Interface on 8&9 series sets

Scenario: The Free Desktop IP-Touch Interface is installed and configured on


the Presentation Server.

The Presentation Server and the Tomcat server are running

Outcome: The Desktop IP-Touch Interface will run on the IP-Touch sets and will
be ready for use.

Time: 5 minutes

An IP-Touch application corresponding to the FDE IP-Touch Interface must be


declared on the OmniPCX Enterprise to display access to the application on Free
Desktop subscribers' sets.

1. Access the OmniPCX Enterprise configuration tool

2. Select Alcatel 8&9 Series > Alcatel Series 8&9 applications

3. Select Create

4. Fill the following attributes:

Application Id Enter FDEI

All Rights Reserved © Alcatel-Lucent 2008 Page 54


Application name Enter Free Desktop

The « Application Id » must be the same identifier than this one you have enter
during the Presentation Server configuration (Here « FDEI »).

5. Confirm your entries

6. Once the application has been defined, associate it to the class of service (COS)
for Free Desktop subscribers. Only users in this class of service will have access
to the FDE IP-Touch Interface via their set

7. For each class of service with the Free Desktop feature:

a. Select:

Alcatel 8&9 Series  Alcatel Series 8&9 Classes of Service  COS applications

b. Review/modify the following attribute:

Application COS Select the Free Desktop class of service.


In our Example the COS number is 0
External Application No x
Id FDEI
Name Free Desktop
Priority Change the priority to a free priority
number. For example set it to 8 (if all
priorities from 0 to 7 are used). Default
value: 0

c. Confirm your entries

8. The last step consists in associating the Free Desktop class of service to Free
Desktop subscribers if this has not been done already. For each IP-Touch
subscriber with Free Desktop:

a. Select Users > Alcatel 8&9 Series Parameters

b. Review/modify the following attributes:

Directory Number Select the subscriber number to be modified.

Application COS Change the application's COS if needed.

All Rights Reserved © Alcatel-Lucent 2008 Page 55


c. Confirm your entries

The Free Desktop application will appear on the menu tab of the IP-Touch (in
8th position since we set priority to 8):

SCREENSHOT 36 - Free Desktop in 8th position

All Rights Reserved © Alcatel-Lucent 2008 Page 56


14 Uninstalling

14.1 Free Desktop Environment Uninstalling

Goal: To uninstall Free Desktop Environment from your computer, or one


of its component.

Scenario: You do not want to use Free Desktop anymore.

Outcome: Free Desktop will be removed from your computer.

Time: 1 minute.

1. Stop Tomcat 5.0.28. If you do not want to, some files will not be
uninstalled and the uninstaller will ask you to reboot the computer.

2. Click Start/Programs/FreeDesktop/WebService/Uninstall. The Uninstaller


program is launched

3. Unselect the components you don’t want to uninstall

4. Click Uninstall

5. Uninstaller will ask you if you want to keep or delete the FreeDektop data
base, and you if you want to delete the logs of each component or not.
Click YES to remove all files or click No to keep the logs or the data base.
If some files have not been deleted, the Uninstaller program requests a
reboot.

6. Click OK or click Cancel to remove all files but keep the Database

7. Click Finish

If you want to uninstall the Free Desktop IPTouch application, you have to continue
the uninstallation in the next chapter.

14.2 Free Desktop Web Interface Uninstalling

Goal: To uninstall Free Desktop Web Interface from your computer.

Scenario: You do not want to use Free Desktop Web Interface anymore.

Outcome: Free Desktop Web Interface will be removed from your computer.

All Rights Reserved © Alcatel-Lucent 2008 Page 57


Time: 1 minute.

1. Click Start/Programs/FreeDesktop/WebInterface/Uninstall. The


Uninstaller program is launched

2. Unselect the components you don’t want to uninstall

3. Click Uninstall. The Uninstaller must restart Tomcat

4. Click OK or click Cancel to remove all files but keep logs. If some files
have not been deleted, the Uninstaller program requests a reboot

5. Click Finish

14.3 Complete Free Desktop IP-Touch Interface Uninstalling

Goal: To finish uninstallation of the Free Desktop IP-Touch Interface from your
computer.

Scenario: You do not want to use Free Desktop IP-Touch Interface anymore.

Outcome: Free Desktop IP-Touch Interface will be unconfigured in the XML API /
UC and OXE.

Time: 2 minutes.

1. Delete the FDE IP-Touch Interface from the Presentation Server:

a. Log on as admin on the Xml Api server (or UC), via its web
interface;

b. Click on Services in the menu to the left of the page. A


configuration page is displayed.

c. In the list of services, locate the service whose entity type is


Presentation Server

d. Click the icon in the Action column

e. A PRS Application Management- Presentation Server Global


Parameters configuration page is displayed, see figure.

f. Click Next. A second administration page, where IP-Touch


applications are listed (if they exist); see: figure: List of IP Touch
Application Example Window.

All Rights Reserved © Alcatel-Lucent 2008 Page 58


g. Click on Next to reach the page where the IP-Touch applications are
listed;

h. Select the FDEI application and click on the corresponding icon


labeled Delete selected on this page. A confirmation window
appears

i. Select the FDEI application and click the icon

j. Click Next

k. Click Finish

2. Delete the FDE IP-Touch Interface from the OmniPCX Enterprise.

l. Access the mgr configuration tool

m. Select Alcatel 8&9 Series  Alcatel Series 8&9 applications 


Delete

n. In the Delete screen, enter FDEI as ID

o. Press Ctrl+V to validate

Now the Free Desktop IP Touch Interface is fully removed.

All Rights Reserved © Alcatel-Lucent 2008 Page 59


15 Appendix

15.1 Table of Figures

FIGURE 1 - FREE DESKTOP ARCHITECTURE ...........................................................................9

FIGURE 2 - SEQUENCE DIAGRAM: LOGON - IP TOUCH INTERFACE .................................................... 10

FIGURE 3 - SEQUENCE DIAGRAM: WEB INTERFACE ............................................................... 11


FIGURE 4 - APPLICATION AVAILABILITY ......................................................................... 15
FIGURE 5 - PHONE SET COMPATIBILITY ......................................................................... 16
SCREENSHOT 1 - JAVA 2 SDK INSTALLATION – WELCOME SCREEN ....................................................... 25

SCREENSHOT 2 - WINDOWS INSTALLER CONFIGURATION - PROGRESS BAR ................................................. 25


SCREENSHOT 3 - COMMENCEMENT OF INSTALLATION ................................................................. 25
SCREENSHOT 4 - LICENSE AGREEMENT............................................................................ 26
SCREENSHOT 5 - J2SE DEVELOPMENT KIT COMPONENT SELECTION & INSTALLATION PATH..................................... 27
SCREENSHOT 6 - INSTALLATION PROGRESS BAR ..................................................................... 28
SCREENSHOT 7 - J2SE RUNTIME ENVIRONMENT COMPONENT SELECTION & INSTALLATION PATH ................................. 29
SCREENSHOT 8 - SELECT BROWSER REGISTRATION................................................................... 30

SCREENSHOT 9 - INSTALLATION PROGRESS BAR ..................................................................... 31


SCREENSHOT 10 - INSTALLATION COMPLETE ....................................................................... 32
SCREENSHOT 11 - APACHE TOMCAT INSTALLATION – WELCOME SCREEN .................................................. 33
SCREENSHOT 12 - LICENSE AGREEMENT .......................................................................... 34
SCREENSHOT 13 - SELECT: INSTALL TYPE AND OPTIONAL COMPONENTS ................................................... 34
SCREENSHOT 14 - SELECT: INSTALL LOCATION ..................................................................... 35
SCREENSHOT 15 - CONFIGURATION PAGE ......................................................................... 36
SCREENSHOT 16 - PATH OF JAVA VIRTUAL MACHINE................................................................. 37
SCREENSHOT 17 - INSTALLATION PROGRESS BAR .................................................................... 38
SCREENSHOT 18 - INSTALLATION COMPLETE ....................................................................... 39
SCREENSHOT 19 - FREE DESKTOP INSTALLATION – WELCOME SCREEN .................................................... 40
SCREENSHOT 20 - LICENSE AGREEMENT .......................................................................... 41
SCREENSHOT 22 - SELECTION OF INSTALLATION FOLDER .............................................................. 42
SCREENSHOT 23 - LOCATION OF FREE DESKTOP DATABASE ............................................................ 43

All Rights Reserved © Alcatel-Lucent 2008 Page 60


SCREENSHOT 24 - TOMCAT PORT SPECIFICATION .................................................................... 44
SCREENSHOT 25 - INSTALLATION PROGRESS BAR .................................................................... 45
SCREENSHOT 26 - INSTALLATION COMPLETE ....................................................................... 46
SCREENSHOT 27 - TOMCAT SERVICE MANAGER.................................................................. 47
SCREENSHOT 28 - IP-TOUCH INTERFACE START PAGE ............................................................ 50
SCREENSHOT 29 - XML API SERVICE CONFIGURATION PAGE ...................................................... 51
SCREENSHOT 30 - LIST OF IP TOUCH APPLICATION EXAMPLE WINDOW ............................................... 52
SCREENSHOT 31 - IP-TOUCH APPLICATION CREATION EXAMPLE .................................................... 53

SCREENSHOT 32 - FREE DESKTOP IN 8TH POSITION ............................................................... 56

All Rights Reserved © Alcatel-Lucent 2008 Page 61


www.alcatel-lucent.com

All Rights Reserved © Alcatel-Lucent 2008 Page 62