You are on page 1of 27

Free Desktop 2.

Administration Guide

Doc Reference Document title File name


Alcatel-Lucent_FreeDesktop-
SK934071114-4 ed03 Free Desktop Administration Guide Ed 03 v2_Administration_Guide.doc

Function Name
Author Free Desktop Developer Seni Kerboul
Checked By Program Manager David Thépot
Approved by

Alcatel-Lucent Services for Enterprise


All Rights Reserved © Alcatel-Lucent 2007
HISTORY

REF DATE ORIGINATOR CHANGE NOTE


SK934071114-4 ED01 2007-11-14 SK Creation of the document.
SK934071114-4 ED02 2007-11-25 SK English Correction.
SK934071114-4 ED03 2007-12-11 SK Update document format.

Page 2
All Rights Reserved © Alcatel-Lucent 2007
NOTE:

Product specifications contained in this document are subject to change


without notice. Products and services described in this document may not be
offered in every country. For the most current information, please contact
your Alcatel-Lucent representative or your Alcatel-Lucent equipment
provider.

Copyright (c) 2007 Alcatel-Lucent. All rights reserved for all countries. This
document may not be reproduced in whole or in part without the express
written permission of Alcatel-Lucent.

Alcatel-Lucent® and the Alcatel-Lucent logo are registered trademarks of


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

The CE mark indicates that this product conforms to the following Council
Directives:
- 89/336/CEE (concerning electro-magnetic compatibility)
- 73/23/CEE (concerning electrical safety)
- 1999/5/CE (R&TTE)

Page 3
All Rights Reserved © Alcatel-Lucent 2007
Table of Contents

1 Scope of this Document ......................................................................... 5


2 Free Desktop Environment features description ............................................ 6
2.1 Free Desktop, a mobility solution for Alcatel-Lucent OmniPCX Enterprise ............... 6
2.2 Free Desktop users and Temporary users ...................................................... 6
2.3 Free Desktop Subscriber Rights .................................................................. 6
2.4 Auto-Log-off ........................................................................................ 7
2.5 Dedicated OXE hosting temporary and/or virtual users...................................... 7
2.6 How to keep the same number of users per OXE?............................................. 7
2.7 Emergency calls – Entity number updatable during a move ................................. 7
2.8 Save phone book Licences ........................................................................ 8
2.9 Unified Communication compatibility table ................................................... 8
2.10 Upgrade Free Desktop 1.0 to Free Desktop 2.0 ............................................... 8
2.11 Restore users’ aliases configuration for Free Desktop 1.0 ................................... 8
3 Free Desktop Configuration..................................................................... 9
3.1 Access to the web administration interface ................................................... 9
3.2 General Parameters ............................................................................... 9
3.3 Configure the PBX network...................................................................... 12
3.4 Configure Free Desktop users ................................................................... 14
3.5 Configure Temporary users...................................................................... 19
3.6 Configure Auto-Log-Off .......................................................................... 23
3.7 Export configuration ............................................................................. 25
3.8 Sign out............................................................................................. 25
4 Free Desktop administration ................................................................. 25
4.1 Traces .............................................................................................. 25
4.2 Start & stop Free Desktop ....................................................................... 26
4.3 Expert configuration ............................................................................. 26
5 Troubleshooting ................................................................................ 27

Page 4
All Rights Reserved © Alcatel-Lucent 2007
1 Scope of this Document
This document describes procedures that may be requested before or after installing the
Alcatel Free Desktop Environment software.
Further information is provided in the installation CD-ROM in the Readme.txt file.
The table below lists the components of the Free Desktop application:
table 1: Free Desktop Environment Components

Free Desktop Environment 2.X


Detailed components:
Free Desktop Server 2.3
Free Desktop IP-Touch interface 2.3
Free Desktop Web Interface 3.0
Operating Systems Microsoft Windows 2003 SP1
release 6.2, 7.x
OXE version
release 8.0 (g1.302.7 or upper)
4010, 4010 + TSC IP, 4020, 4022, 4035, 4037, 4008,
Supported sets
4018, 4019, 4028, 4029, 4038, 4039, 4068

Java version JDK 1.5

Application Server Tomcat 5.0


Alcatel-Lucent XML API 5.0 (XML API 5.0.000.541 or upper and UC
or Unified Communication 5.0.000.543 or upper)

Page 5
All Rights Reserved © Alcatel-Lucent 2007
2 Free Desktop Environment features description
2.1 Free Desktop, a mobility solution for Alcatel-Lucent OmniPCX Enterprise
Free Desktop Environment is mobility feature allowing:
- to share the extensions(phone sets) of a company
- to simplify the move operations of the users
- to get easily the configuration of the users’ extensions.

The users can log on an extension and automatically retrieve their phone profile (directory number,
discrimination, programmable keys…)

The Free Desktop application allows users to affect (log on) or disaffect (log off) their phone
number on a phone set.

The Free Desktop Web Service is in charge of the subscribers’ moves in the PBX.

2.2 Free Desktop users and Temporary users


Temporary directory numbers are used to replace user directory numbers who have been moved
from THEIR extension to another extension.
For each node, you must have as many temporary directory numbers as users with an initial
extension.
The users who are initially logged off and the Shared extensions do not require temporary directory
numbers.

Before configuring any Free Desktop subscriber, we recommend configuring their accounts in their
original position:
- Users who are originally on a specific phone set must be assigned to this phone set. This
concerns real users and users (directory numbers) assigned to shared phone sets.
- Users who do not have an original physical phone set must be on a virtual location
- Pools of temporary directory numbers associated to each node must be on a virtual location

2.3 Free Desktop Subscriber Rights

2.3.1 Mobile right


If enabled, the subscriber can move to another set.

2.3.2 Shared right


If enabled, the subscriber allows another subscriber to move to their current set.

2.3.3 Protected right


If enabled, the subscriber does not allow other subscribers to move to their original set.

Page 6
All Rights Reserved © Alcatel-Lucent 2007
2.3.4 Network right
If enabled, the subscriber can move to a set on another node.

2.3.5 Auto-Log-On right


If enabled, a user is automatically logged on back his phone set when this one is free or freed. The
“Automatic log on back” feature runs when:
- either when the user logs off AND his phone set is free
- or when his phone set is freed and the user is logged off

2.4 Auto-Log-off
If some users forget to log off leaving their work space, they can be automatically logged off by the
system. Those users must be defined in a list, and a periodic date to check if the users are logged
off must be associated to this list. This feature is called “Auto-Log off”.
a. Several list can be defined
b. A list can contain one or several users and/or one or several ranges of users. The
users are defined thanks their directory number.
c. The periodicity can be daily, weekly, monthly or annually at a specific hour.
i.e.: log off user 1001 each Saturday at 6PM.

2.5 Dedicated OXE hosting temporary and/or virtual users


You can select an OXE for hosting your temporary and/or virtual user (refer to chapter 3.4.2)

2.6 How to keep the same number of users per OXE?


A network move keeps the same number of subscriber by PBX (if this feature is enabled). There are
2 ways:
d. Mode 1: Without dedicated PBX, the moves follow these rules:
i. When a user logs on another node, a temporary user is selected on the
target node to replace the user.
ii. When a user logs off, he is moved on his original node to keep the same
number of temporary users associated to each node.
e. Mode 2: With a dedicated PBX to Free Desktop, all virtual subscribers are hosted
on this PBX. The moves follow these rules:
i. When a user logs on another node, a temporary user is selected to replace
the user on the dedicated PBX associated to the target PBX.
ii. When a user logs off, he is moved to the dedicated PBX associated to his
original PBX to keep the same number of temporary users associated to
each node.
This feature is applied to all Free Desktop users of the installation and can be activated /
deactivated in the configuration of the Free Desktop Web Service. By default, this feature is
activated.

2.7 Emergency calls – Entity number updatable during a move


According to your phone system configuration, emergency calls can be managed by entity.

Page 7
All Rights Reserved © Alcatel-Lucent 2007
When a user logs on a phone set, his entity number is become the one of the previous user. This
feature is applied to all Free Desktop users of the installation and can be activated / deactivated in
the configuration of the Free Desktop Web Service. By default, this feature is deactivated.

2.8 Save phone book Licences


When a Free Desktop User is log off, his phone book licence is saved in Free Desktop database. This
licence will be restored during user log on.

2.9 Unified Communication compatibility table

table 2: Unified Communication compatibility

Free Desktop 2.x


Single PBX PBX network
Mono API/UC Multi
API/UC
XML API 2.2, 3.x Releases not supported
UC 3.x & 4.x :
My Phone
Releases not supported
My Assistant
My Messaging
XML API 5.0 OK OK WR
UC 5.0 :
My Phone OK* OK* WR
My Assistant OK OK OK
My Messaging OK OK OK

OK: Fully compatible


OK*: Nomadic functionality does not work when the user is logged off Configure the protected and
auto-log-on Free Desktop rights to the nomadic users to be sure they are always logged on a set.
WR: With Restrictions. After such a move, My Phone Web Services / My Phone application is not
available for the user until he moves back on a PBX cover by his initial XML API / UC.

2.10 Upgrade Free Desktop 1.0 to Free Desktop 2.0


Free Desktop release 2 is not compatible with Free Desktop release 1.
Nevertheless, a procedure is available to upgrade from Free Desktop 1.0 to Free Desktop 2.0
(Please refer to chapter 3.3.2).

2.11 Restore users’ aliases configuration for Free Desktop 1.0


Free Desktop release 1 is not compatible with Free Desktop release 2.

Page 8
All Rights Reserved © Alcatel-Lucent 2007
Nevertheless, a procedure is available to downgrade from Free Desktop 2.0 to Free Desktop 1.0
(Please refer to chapter 3.3.2).
Caution: please take in account that Free Desktop step 1 don’t manage “auto-logoff” and “entity
movable”

3 Free Desktop Configuration


3.1 Access to the web administration interface
The Free Desktop Server Interface URL is as follows:
http://[hostname]:[HTTP_port]/freedesktop/
Where [hostname] is the name of the machine on which Free Desktop Server runs, and
[HTTP_port] is the HTTP port number configured in Tomcat (typically: 8080).
Log on as admin on the Authentification Page.

Figure 1: Authentification Page

To change the Authentification parameters, please edit file:


…\Tomcat 5.0\conf\tomcat-users.xml

And change the line :


<user username="admin" password="admin" roles="admin,manager"/>

3.2 General Parameters

Click on the “General” thumbnail to display the General page.


You can choose between two modes:

Page 9
All Rights Reserved © Alcatel-Lucent 2007
3.2.1 Normal Mode

Figure 2: General Page (Normal Mode)

In this mode you can enable:


- the “Entity movable” feature (refer to chapter 2.7)
- the “Keep number of user per OXE” feature (refer to chapter 2.6)
- the “Forward Policy” feature if you want that the Free Desktop manage the forward policy
- the “Save phone book licence” feature (refer to chapter 2.8)
- the “My Assistant detection enabled” feature if you want that the Free Desktop detect my
assistant user. If you set this feature at “true”, you will have two ways to detect these
users: automatically (longer) or by adding RSI numbers in the RSI number list (recommend).
You can delete a RSI number by clicking on the icon below each user in the RSI number
list (when a My Assistant user is detected, his immediate forward on RSI point is not
modified).

Figure 3: RSI number List

3.2.2 Expert Mode

Page 10
All Rights Reserved © Alcatel-Lucent 2007
Figure 4: General Page (Expert Mode)

In this mode you can enable:


- features of normal mode
- the “Cache enable” feature if you want to optimize the processing time
- you can set the maximum number of XML API (Please note that the maximum number of XML
API is limited at 10)
- you can set the “Max try for set Mac address”: the number of time the Free Desktop will try
to change the Mac address of a phone set during a move(if this change failed).
- you can set the “Sleep after set Mac address failed”: the time between the moment where
the Free Desktop failed to change the Mac address and the moment where the Free Desktop
will retry to change it
- you can set the “Max try for set Pbx address”: the number of time the Free Desktop will try
to change the Pbx address of a phone set during a move(if this change failed).

Page 11
All Rights Reserved © Alcatel-Lucent 2007
- you can set the “Sleep after set Pbx address failed”: the time between the moment where
the Free Desktop failed to change the Pbx address and the moment where the Free Desktop
will retry to change it
- you can set the “Max try for change station type”: the number of time the Free Desktop will
try to change the phone set Type during a move(if this change failed).
- you can set the “Sleep after change station type”: the time between the moment where the
Free Desktop failed to change phone set type and the moment where the Free Desktop will
retry to change it
- You can launch the Free Desktop upgrade tool add-on (refer to chapter 2.10/2.11): you have
to choose if you want to upgrade the Free Desktop 1 to Free Desktop 2 (upgrade) or if you
want to downgrade the Free Desktop 2 to Free Desktop 1 (restore) by changing the
“available actions” field. Then Click on the icon below to start the action. This icon will
be modified by the icon during this operation. The upgrade/restore operation is finished
when the clock icon disappear. You can check if the upgrade/restore operation succeeded
in the “FD-Ugrade.log” file (refer to chapter 4.1).
- You can launch the Free Desktop Auto Log Off add-on (refer to chapter 2.4): you have to
choose if you want to start or stop the Auto Log Off feature by changing the “available
actions” field. Then Click on the icon below to start the action.

You can modify all fields of the Free Desktop configuration and click on the “Update” button to
save it.

Caution: this mode allows the administrator to force delete users or configured OXE for Free
Desktop

3.3 Configure the PBX network

3.3.1 Description
Click on the “PBX Links” thumbnail to display the PBX Links page.

Page 12
All Rights Reserved © Alcatel-Lucent 2007
Figure 5: PBX Links Page

This page is used to create and configure all XML API (or UC) connector and Node.

3.3.2 Create a new XML API (or UC) Connector


Please fill in all Field in the “Create” window and click on the “Create” button to create a PBX
connector.

Figure 6: Create connector

• The “Host” field represents the address of your XML API (or UC) Server.
• The “Port” field represents the port of your XML API (or UC) Server.
• The “FlexLM Host” field represents the address of your FlexLM Server.
• The “FlexLM Port” field represents the port of your FlexLM Server.
• The “Login” field represents the administrator log in of your XML API (or UC) Server.
• The “Password” field represents the admin password of your XML API (or UC) Server.

If your connector is correctly created, it will appear in the connectors table.

Page 13
All Rights Reserved © Alcatel-Lucent 2007
Figure 7: Connectors Table

Any node registered in your XML API (or UC) server will appear in the nodes table.

Figure 8: Nodes Table

Please check the checkbox below each node you want to configure for the Free Desktop and choose
the PBX where the temporary user will be hosted by using list box.
If you configure a new PBX in your XML API server, please click on the icon and click on the
modify button.
If you have added a user in PBX and you want to configure it to Free Desktop you have to click on
the reload icon before create this user in the Free Desktop database.
You can only disable a PBX configured for Free Desktop if there is no depended Free Desktop
user(delete all user in the user page before disable a node).Note: you can force disable if you are
in expert mode (refer to chapter 3.3.2)

3.4 Configure Free Desktop users

3.4.1 Description
Click on the “User config” thumbnail to display the User Configuration page.

Page 14
All Rights Reserved © Alcatel-Lucent 2007
Figure 9: User Configuration Page

This page is used to create and configure all Free Desktop User.

3.4.2 Add a user


There are two ways to add a user in the Free Desktop List:
• By number: you have just to check the “Number” radio button and enter the number
you want to add to the Free Desktop list in the “Number” Field and click on the
“Add” button (You can only add an existing user in PBX).

Figure 10: Add a User by number

• By range of number: you have just to check the “Range of Number” radio button and
enter the first number and the last number of the range you want to add to the Free
Desktop list in the “First Number” and “Last Numbers” fields and click on the “Add”
button (Only existing users in PBX will be added).

Page 15
All Rights Reserved © Alcatel-Lucent 2007
Figure 11: add Users by range of number

All your added users will appear in the users table.


You can observe many information on the following table:
• Directory Number
• User on original set:
o i.e.1 the user “13110” have a permanent physical set, you can see in the table
that this user is connected on his original set.
o i.e.2 the user “13339” is connected on the original set of the user “13329”.
• Owner of Current set:
o i.e.1 the owner of the set where the user “13339” is currently logged is the
user “13329”.
o i.e.2 the user “13329” is not logged because his “Owner of Current set” cell is
empty.
• You can change user rights by clicking on those icons: (please consult subscriber
rights chapter 2.1)

Figure 12: Users Table

3.4.3 Search a user


There are many ways to search a user in the Free Desktop List:
• By number: you have just to check the “Number” radio button and enter the number
you want to search in the “Number” Field and click on the “Search” button (if this
number is not registered in the Free Desktop list, the following message will be
displayed: “nothing found to display”).

Page 16
All Rights Reserved © Alcatel-Lucent 2007
Figure 13: Search users by number

• By range of number: you have just to check the “Range of Number” radio button and
enter the first number and the last number of the range you want to search in the
“First Number” and “Last Numbers” fields and click on the “Search” button (Only
existing users configured for Free Desktop in PBX will be displayed).

Figure 14: Search users by range

• If you click on the “Search” button without filling “Number”, “First Number” and
“Last Number” fields, the user table will display all Free Desktop Users.

Figure 15: Search users (empty)

• If you choose the search by range and you fill only the “First Number” Field, only
numbers bigger than this number will be displayed.

Page 17
All Rights Reserved © Alcatel-Lucent 2007
Figure 16: Search user by range (First Number)

• If you choose the search by range and you fill only the “Last Number” Field, only
numbers lower than this number will be displayed.

Figure 17: Search user by range (Last Number)

3.4.4 Delete a user


There are three ways to delete a user in the Free Desktop List:
• By number: you have just to check the “Number” radio button and enter the number
you want to delete in the “Number” Field and click on the “Delete” button (A
confirmation will be asked).

Figure 18: Delete user by number

• By range of number: you have just to check the “Range of Number” radio button and
enter the first number and the last number of the range you want to search in the
“First Number” and “Last Numbers” fields and click on the “Delete” button (A
confirmation will be asked).

Page 18
All Rights Reserved © Alcatel-Lucent 2007
Figure 19: Delete user by range of number

• You can delete a user by clicking on the icon below each user in the users table.

Caution: In normal mode (refer to chapter), you can only delete a user when he is located on is
original phone set (or logged off if it’s a virtual user).

3.5 Configure Temporary users

3.5.1 Description
Click on the “Temp Subscriber” thumbnail to display the Temporary User page.

Figure 20: Temporary User Page

This page is used to create and configure all Free Desktop Temporary User.

3.5.2 Add a temporary user


There are two ways to add a temporary user in the Free Desktop List:
• By number: you have just to check the “Number” radio button and enter the number
you want to add to the Free Desktop list in the “Number” Field and click on the
“Add” button (You can only add an existing user in PBX).

Page 19
All Rights Reserved © Alcatel-Lucent 2007
Figure 21: Add a temporary user by number

• By range of number: you have just to check the “Range of Number” radio button and
enter the first number and the last number of the range you want to add to the Free
Desktop list in the “First Number” and “Last Numbers” fields and click on the “Add”
button (Only existing users in PBX will be added).

Figure 22: Add a temporary users by range of number

All your added temporary users will appear in the users table.
You can observe many information on the following table:
• Directory Number
• User on original set: i.e. No temporary user have a permanent physical set because
nobody is connected on their set.
• Owner of Current set:
o i.e.1 the owner of the set where the user “A003” is currently logged is the
user “13329”.
o i.e.2 the user “A001” is not logged because his “Owner of Current set” cell is
empty.

Figure 23: Temporary Users Table

Page 20
All Rights Reserved © Alcatel-Lucent 2007
3.5.3 Search a temporary user
There are many ways to search a temporary user in the Free Desktop List:
• By number: you have just to check the “Number” radio button and enter the number
you want to search in the “Number” Field and click on the “Search” button (if this
number is not registered in the Free Desktop list, the following message will be
displayed: “nothing found to display”).

Figure 24: Search temporary user by number

• By range of number: you have just to check the “Range of Number” radio button and
enter the first number and the last number of the range you want to search in the
“First Number” and “Last Numbers” fields and click on the “Search” button (Only
existing users configured for Free Desktop in PBX will be displayed).

Figure 25: Search temporary users by range of number

• If you click on the “Search” button without filling “Number”, “First Number” and
“Last Number” fields, the temporary user table will display all Free Desktop
temporary users.

Page 21
All Rights Reserved © Alcatel-Lucent 2007
Figure 26: Search temporary users (empty)
• If you choose the search by range and you fill only the “First Number” Field, only
numbers bigger than this number will be displayed.

Figure 27: Search temporary users by range of number (First Number)

• If you choose the search by range and you fill only the “Last Number” Field, only
numbers lower than this number will be displayed.

Figure 28: Search temporary users by range of number (Last Number)

3.5.4 Delete a temporary user


There are three ways to delete a temporary user in the Free Desktop List:
• By number: you have just to check the “Number” radio button and enter the number
you want to delete in the “Number” Field and click on the “Delete” button (A
confirmation will be asked).

Page 22
All Rights Reserved © Alcatel-Lucent 2007
Figure 29: Search Temporary User Result Table

• By range of number: you have just to check the “Range of Number” radio button and
enter the first number and the last number of the range you want to delete in the
“First Number” and “Last Numbers” fields and click on the “Delete” button (A
confirmation will be asked).

Figure 30: Search Temporary User Result Table

• You can delete a temporary user by clicking on the icon below each temporary
user in the temporary users table

Caution: In normal mode (refer to chapter), you can only delete a temporary user when he is
logged off.

3.6 Configure Auto-Log-Off

3.6.1 Description
Click on the “Auto Log Off” thumbnail to display the Auto Log Off page.

Page 23
All Rights Reserved © Alcatel-Lucent 2007
Figure 31: Auto Log Off Page

This page is used to create and configure auto log off tasks.

3.6.2 Create an Auto Log Off task


There are three ways to create an auto log off:
• By number: you have just to choose the frequency the start hour and start minute and
then check the “Number” radio button and enter the directory number in the
“Number” Field and click on the “Create” button. This task will be affected to this
number (You can only affect a task an existing Free Desktop user).

Figure 32: Create Auto Log Off Task for a User

• By range of number: you have just to choose the frequency the start hour and start
minute and then check the “Range of Number” radio button and enter the first
number and the last number of the range in the “First Number” and “Last Numbers”
fields and click on the “Create” button. This task will be affected to those numbers.

Page 24
All Rights Reserved © Alcatel-Lucent 2007
Figure 33: Create Auto Log Off Task for Users

• You can modify or delete a task by clicking those icons

Figure 34: Auto Log Off Task Table

3.7 Export configuration


For each table you can create an export in CSV, Excel, XML, PDF or RTF file

Figure 35: Export Options

3.8 Sign out


If you want to leave the configuration interface you can click on this icon

Figure 36: Export Options

4 Free Desktop administration


4.1 Traces
The Free Desktop Web Service generates traces. They can be useful to determine the state of the
service or error causes. You can find them in the logs directory of the Tomcat Server Installation
directory. Once the service has started, 9 files are available:
- FD-Errors.log: reports move errors.
- FD-Ugrade.log: reports the result of restore/upgrade operation.

Page 25
All Rights Reserved © Alcatel-Lucent 2007
- FD-AutoLogOff.log: generate traces by the Auto-logoff feature.
- FD-Config.log: generate traces by the configuration module.
- FD-Server.log: traces during start and move operation and traces of move algorithm.
- FD-WebService.log: communication between Free Desktop clients and server.
- FD-XmlApi.log: communication between Free Desktop server and XML API.
- FD-WebClient.log: generate traces by the Free Desktop web client.
- FD-PbxLink.log: traces according to OXE operations.

4.2 Start & stop Free Desktop


You have to start the tomcat server to start the Free Desktop server.
You have to stop the tomcat server to stop the Free Desktop server.

4.3 Expert configuration


Possible log levels are: DEBUG, INFO, WARN, ERROR and FATAL. Default value is INFO.
However to change it in anyway you have to modify the level name in
…\Tomcat 5.0\webapps\freedesktop\conf\traces.xml.
i.e. :
<category name="com.alcatel.proserv.freedesktop"
additivity="false">
<priority value="INFO" />
<appender-ref ref="FreeDesktopServer" />
</category>

You must restart the Free Desktop Server to update modifications.

Page 26
All Rights Reserved © Alcatel-Lucent 2007
5 Troubleshooting
For troubleshooting you can consult the Readme.txt file located on the Free Desktop Environment
CD-ROM to help you solve your problem. This file lists the most common issues. If the problem
persists, please contact Alcatel-Lucent Technical Support

END OF DOCUMENT

Page 27
All Rights Reserved © Alcatel-Lucent 2007

You might also like