Professional Documents
Culture Documents
Administration Guide
Function Name
Author Free Desktop Developer Seni Kerboul
Checked By Program Manager David Thépot
Approved by
Page 2
All Rights Reserved © Alcatel-Lucent 2007
NOTE:
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.
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
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
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.
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
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.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.
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.
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”
Page 9
All Rights Reserved © Alcatel-Lucent 2007
3.2.1 Normal Mode
Page 10
All Rights Reserved © Alcatel-Lucent 2007
Figure 4: General Page (Expert Mode)
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.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.
• 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.
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.
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.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.
• 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
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).
• 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.
• 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.
• 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.1 Description
Click on the “Temp Subscriber” thumbnail to display the Temporary User page.
This page is used to create and configure all Free Desktop Temporary User.
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).
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.
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”).
• 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).
• 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.
• If you choose the search by range and you fill only the “Last Number” Field, only
numbers lower than this number will be displayed.
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).
• 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.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.
• 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
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.
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