Professional Documents
Culture Documents
Installation Guide
Issue Date
02 2008-11-20
Huawei Technologies Co., Ltd. provides customers with comprehensive technical support and service. For any assistance, please contact our local office or company headquarters.
Website: Email:
Copyright Huawei Technologies Co., Ltd. 2008. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd.
Notice
The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but the statements, information, and recommendations in this document do not constitute a warranty of any kind, express or implied.
Contents
Contents
1 Installation Mode.......................................................................................................................1-1 2 Software and Hardware Requirements.................................................................................2-1 3 Installing the HEDEX in Windows.........................................................................................3-1
3.1 Installing the HEDEX for the First Time........................................................................................................3-2 3.2 Installing the HEDEX when Previous HEDEX Installations Exist..............................................................3-14 3.3 Adding Libraries in the HEDEX...................................................................................................................3-16 3.4 Starting the HEDEX Service.........................................................................................................................3-17 3.5 Stopping the HEDEX Service.......................................................................................................................3-19 3.6 Uninstalling the HEDEX...............................................................................................................................3-19 3.7 Troubleshooting............................................................................................................................................3-21 3.7.1 Failing to Install the HEDEX...............................................................................................................3-22 3.7.2 Failing to Open the HEDEX Interface after Starting the HEDEX Service..........................................3-22 3.7.3 The HEDEX Service Failed to Be Started due to Port Occupation.....................................................3-23 3.7.4 "HTTP Status 404" Is Displayed when the HEDEX Service Is Started..........................................3-24 3.7.5 Users in the LAN Cannot Access the HEDEX on a Server(Case 1)....................................................3-25 3.7.6 Users in the LAN Cannot Access the HEDEX on a Server(Case 2)....................................................3-27
Issue 02 (2008-11-20)
Figures
Figures
Figure 3-1 Choosing the setup language..............................................................................................................3-2 Figure 3-2 Installation introduction......................................................................................................................3-3 Figure 3-3 Software license agreement................................................................................................................3-4 Figure 3-4 Browsers supported by the HEDEX...................................................................................................3-5 Figure 3-5 Filling in basic information................................................................................................................3-6 Figure 3-6 Choosing the installation mode..........................................................................................................3-7 Figure 3-7 Set the Password of the HEDEX Administrator.................................................................................3-8 Figure 3-8 Selecting the installation path and libraries........................................................................................3-9 Figure 3-9 Selecting the installation path...........................................................................................................3-10 Figure 3-10 Entering the port number................................................................................................................3-11 Figure 3-11 Confirming the installation path and port number..........................................................................3-12 Figure 3-12 Setup status.....................................................................................................................................3-13 Figure 3-13 Installation completion...................................................................................................................3-14 Figure 3-14 Upgrading HEDEX.........................................................................................................................3-15 Figure 3-15 Installing libraries...........................................................................................................................3-16 Figure 3-16 HEDEX installation interface.........................................................................................................3-17 Figure 3-17 Viewing the HEDEX service state.................................................................................................3-18 Figure 3-18 Shortcut menu of the HEDEX........................................................................................................3-19 Figure 3-19 Viewing the library path of the HEDEX .......................................................................................3-20 Figure 3-20 dialogue box for uninstallation confirmation.................................................................................3-20 Figure 3-21 dialogue box for removing libraries...............................................................................................3-21 Figure 3-22 Exiting the uninstallation program.................................................................................................3-21 Figure 3-23 Error message for installation failure.............................................................................................3-22 Figure 3-24 Error prompt ..................................................................................................................................3-22 Figure 3-25 Dialogue box on port occupation....................................................................................................3-23 Figure 3-26 Changing the port number of the HEDEX service.........................................................................3-24 Figure 3-27 Dialogue box on prompting you to restart the HEDEX service.....................................................3-24 Figure 3-28 Error Prompt...................................................................................................................................3-25 Figure 3-29 Error prompt ..................................................................................................................................3-26 Figure 3-30 Configuring the port number for the HEDEX service....................................................................3-27 Figure 3-31 Error prompt...................................................................................................................................3-28 Figure 3-32 Setting the proxy server of the LAN..............................................................................................3-29 Figure 4-1 Log information..................................................................................................................................4-4 Issue 02 (2008-11-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. iii
1 Installation Mode
1
Local Mode Server Mode
Installation Mode
The HEDEX (Huawei Electronic Documentation Explorer) uses the browser/server (B/S) architecture. You can access it through the browser. There are two installation modes: local mode and server mode.
You can install the HEDEX on a local PC and use the HEDEX directly. In this mode, other users cannot access the HEDEX.
You can install the HEDEX on a server. All users in the same LAN can access the HEDEX on the server through the browser. If there are multiple users, it is recommended to install the HEDEX on a server. When the HEDEX is installed in server mode, HEDEX users are classified into three types: the unregistered user, registered user, and administrator. Users of different types have different operating rights in the HEDEX.
Issue 02 (2008-11-20)
1-1
2
l l
The HEDEX can be installed and run in Windows, Linux, and Solaris. It supports several types of browsers. For different installation modes, the HEDEX has different requirements for software and hardware. The HEDEX supports the following browsers: Microsoft Internet Explorer 6.0 Microsoft Internet Explorer 7.0
NOTE
If the version of the Internet Explorer is earlier than 6.0, download the latest version of the Internet Explorer from http://www.microsoft.com. It is recommended to use the screen resolution of 1024 x 768 to open the HEDEX interfaces.
Operating system:
Microsoft Windows 2000 Microsoft Windows XP Professional Memory: 512 MB or higher CPU: P4 1.8 GHz or higher Hard disk: 40 GB or higher
Hardware configuration:
Operating system:
Issue 02 (2008-11-20)
Hardware configuration (the following lowest configuration supports 40 concurrent online users):
2-2
Issue 02 (2008-11-20)
Issue 02 (2008-11-20)
3-1
Context
If you install the HEDEX in server mode, you need to set the password of the HEDEX administrator account during the installation. The administrator account is admin. You must remember the password; otherwise, you cannot log in to the HEDEX as the administrator.
Procedure
Step 1 Insert the HEDEX installation CD in the drive. An interface shown in Figure 3-1 is displayed. If your computer is configured to shield the CD-boost function, you can double-click setup.exe in the HEDEX installation CD to start. See Figure 3-1. Figure 3-1 Choosing the setup language
NOTE
This selection determines the language of the processes of installation and uninstall, and also determines the default language of the HEDEX interface.
Step 2 After selecting the setup language, click Next. An interface shown in Figure 3-2 is displayed.
3-2 Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. Issue 02 (2008-11-20)
Issue 02 (2008-11-20)
3-3
Step 4 After reading the items of copyright, select I accept the items of the license agreement and click Next. An interface shown in Figure 3-4 is displayed.
3-4
Issue 02 (2008-11-20)
NOTE
You need to confirm that the browser on your computer meets the requirements. If the version of the Internet Explorer is earlier than 6.0, download the latest version of the Internet Explorer from http://www.microsoft.com.
Issue 02 (2008-11-20)
3-5
Step 6 Specify User Name and Company Name and then click Next. An interface shown in Figure 3-6 is displayed.
3-6
Issue 02 (2008-11-20)
Step 7 Choose the installation mode as required. For details about the installation modes, see 1 Installation Mode. Click Next. Different installation modes requires different installation steps. For details, see the following table. If... Choose Local mode Choose Server mode Then... Go to Step 9. Go to Step 8.
Step 8 In Figure 3-7, enter the HEDEX administrator password and then click Next. The password is a character string of 1 to 16 characters, containing letters, numbers, and underlines.
NOTE
The password in this section is the initial password used by the HEDEX administrator (with the account admin) to log in to the HEDEX. You must remember the password; otherwise, you cannot log in to the HEDEX as the administrator.
Issue 02 (2008-11-20)
3-7
Step 9 The installation program detects automatically whether libraries exist in the installation CD: l If libraries exist in the installation CD, the interface shown in Figure 3-8 is displayed. The installation program installs all the libraries by default. (If you do not need libraries, do not select Install libraries.) Click Browse to modify the installation path of the HEDEX. The installation path cannot contain special characters, such as & | ( ) ; @^>. After selecting the installation path and libraries, click Next to go to Step 10.
3-8
Issue 02 (2008-11-20)
If no library exists in the installation CD, the interface shown in Figure 3-9 is displayed. Click Change to modify the installation path of the HEDEX. The installation path cannot contain special characters, such as & | ( ) ; @ ^ >. After selecting the installation path, click Next to go to Step 10.
Issue 02 (2008-11-20)
3-9
Step 10 Enter the port number on the interface shown in Figure 3-10. Then click Next. The port number must be an integer from 1 to 65535 and the port cannot be occupied by another application. (The installation program can check whether the port number is available.)
3-10
Issue 02 (2008-11-20)
Step 11 Confirm that the installation path and the port number on the interface shown in Figure 3-11 are correct, and then lick Next.
Issue 02 (2008-11-20)
3-11
Step 12 The installation program starts to install the HEDEX and display the installation progress in real time. See Figure 3-12.
3-12
Issue 02 (2008-11-20)
Step 13 When the installation is complete, the interface shown in Figure 3-13 is displayed. If you do not need to log in to the HEDEX immediately, do not select Launch HEDEX. Click Finish to exit the installation program.
Issue 02 (2008-11-20)
3-13
----End
Prerequisite
The HEDEX is not started.
Procedure
Step 1 Insert the installation CD of the HEDEX V1.1 into the CD-RW drive. Figure 3-14 is displayed. If your computer is configured to shield the CD-boost function, you can double-click setup.exe in the HEDEX installation CD to start. See Figure 3-14.
3-14
Issue 02 (2008-11-20)
Step 2 Click Next to complete the upgrade. If the installation CD of the HEDEX V1.1 contains libraries, an interface shown in Figure 3-15 is displayed. If you do not need to install libraries, clear Install libraries. Click Next to complete the upgrade.
Issue 02 (2008-11-20)
3-15
----End
Prerequisite
The HEDEX is not started.
Procedure
Step 1 Insert the installation CD of the HEDEX V1.1 into the CD-RW drive. Figure 3-16 is displayed. If your computer is configured to shield the CD-boost function, you can double-click setup.exe in the HEDEX installation CD to start. See Figure 3-16.
3-16
Issue 02 (2008-11-20)
Result
In the HEDEXAdmin page, click the Library Management tab. All the uploaded library types and storage paths that can be copied are displayed. For the library of different types, the HEDEX uses different methods.
l
If the uploaded library is a basic library, the check box in the Visible column on the Admin page is selected by default. On the Home page, the library is displayed. If the uploaded library is an extended library, the Home page does not display the library by default. If the HEDEX contains the corresponding main library, extended library contents are added to the main library.
NOTE
The library uploaded in this mode is stored in the default library path (that can be viewed in the Path column). When uninstalling the HEDEX, you can delete the library in the path at the same time.
Issue 02 (2008-11-20)
3-17
Prerequisite
The HEDEX is installed.
Context
l
If the HEDEX is installed in local server, you must start the HEDEX service before accessing the HEDEX through a browser in your computer. If the HEDEX is installed on a server, you also must start the HEDEX service on a server. Thus, users in the LAN can access the HEDEX through browsers.
Procedure
Step 1 Double-click on the desktop or choose Start > Program > HEDEX > HEDEX. At the same time, the HEDEX interface is displayed in the browser.
NOTE
When you close the HEDEX interface, the HEDEX service is not stopped.
Step 2 After the HEDEX service is started, the HEDEX tray To view the HEDEX service state, double-click HEDEX service is started. Figure 3-17 Viewing the HEDEX service state
You can perform the following actions on the interface shown in Figure 3-17.
3-18 Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. Issue 02 (2008-11-20)
Open the HEDEX through a browser. Start or stop the HEDEX service. Set the port number and library path of the HEDEX. in the notification area, the shortcut menu shown in Figure 3-18 is
----End
Prerequisite
The HEDEX service is started.
Procedure
Step 1 Right-click in the notification area.
Step 2 On the shortcut menu, click Stop Server. After the service is stopped, the HEDEX tray icon is displayed as ----End .
Prerequisite
The HEDEX is not started.
Issue 02 (2008-11-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. 3-19
Context
Double-click the HEDEX tray . In the Library Path tab(see Figure 3-19),you can view the default and configured library path of the HEDEX.
NOTE
When you install the HEDEX in an OS in the English version, the library whose file names contain Chinese characters cannot be removed; therefore, you need to remove the library manually.
Procedure
Step 1 To uninstall the Start the HEDEX, choose Start > Program > HEDEX > Uninstall. An interface shown in Figure 3-20 is displayed. Figure 3-20 dialogue box for uninstallation confirmation
Step 3 If you need to remove the libraries in the default library path shown in Figure 3-19, click Yes; otherwise, click No. Step 4 The HEDEX begins to be removed and the uninstallation progress is displayed. After uninstallation, the interface shown in Figure 3-22 is displayed. click Finish to exit. Figure 3-22 Exiting the uninstallation program
----End
3.7 Troubleshooting
This topic describes the troubleshooting when you install or run the HEDEX in Windows. 3.7.1 Failing to Install the HEDEX
Issue 02 (2008-11-20) Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. 3-21
3.7.2 Failing to Open the HEDEX Interface after Starting the HEDEX Service 3.7.3 The HEDEX Service Failed to Be Started due to Port Occupation 3.7.4 "HTTP Status 404" Is Displayed when the HEDEX Service Is Started 3.7.5 Users in the LAN Cannot Access the HEDEX on a Server(Case 1) 3.7.6 Users in the LAN Cannot Access the HEDEX on a Server(Case 2)
Procedure
1. 2. 3. Close all the other applications and reinstall the HEDEX. If the problem persists, go to 2. Log out of the current user and reinstall the HEDEX. If the problem persists, go to 3. Restart the computer and reinstall the HEDEX.
3.7.2 Failing to Open the HEDEX Interface after Starting the HEDEX Service
Fault Description
After starting the HEDEX service, the error prompt shown in Figure 3-24 is displayed. Figure 3-24 Error prompt
3-22
Issue 02 (2008-11-20)
Fault Analysis
It may be caused by network delay. Try to reopen the HEDEX interface to solve the problem.
Procedure
1. Right-click the HEDEX tray from the shortcut menu. in the notification area, and then choose Open HEDEX
Fault Analysis
It is because that the HEDEX service port number is occupied by another application. You have to change the HEDEX service port number to start the HEDEX service normally.
NOTE
If you change the service port number of the HEDEX installed in server mode, the HEDEX address that other users in the LAN access changes. For example, after you change the HEDEX service port number from 52199 to 8080, if the former HEDEX address is http://10.71.136.210:52199/hedex/, the HEDEX address is changed to http://10.71.136.210:8080/hedex/.
Procedure
1. . On the displayed Port tab, change the port number of Double-click the HEDEX tray the HEDEX service. See Figure 3-26.
Issue 02 (2008-11-20)
3-23
2.
Click OK. A dialogue box is displayed, as shown in Figure 3-26. Figure 3-27 Dialogue box on prompting you to restart the HEDEX service
3.
Click Yes to restart the HEDEX service. The HEDEX redetects whether the changed port number is in conflict with the port number occupied by any other application. If yes, the system prompts you to change the HEDEX service port number.
3.7.4 "HTTP Status 404" Is Displayed when the HEDEX Service Is Started
Fault Description
After installing the HEDEX and starting the HEDEX service, the system displays "HTTP Status 404" with the Internet Explorer. See Figure 3-28.
3-24 Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. Issue 02 (2008-11-20)
Fault Analysis
When you start the HEDEX service, the HEDEX program is failed to be decompressed.
Procedure
1. 2. 3. Right-click on theHEDEX tray icon and choose Stop Server from the shortcut menu. Check whether the file folder hedex exists in the installation path \server\webapps of the HEDEX. If the file folder exists, delete it. Check whether the file hedex.war exists in the installation path \server\webapps of the HEDEX. If the file does not exist, copy the file datax from the installation package of the HEDEX to the path and then change the file name to hedex.war. Restart the HEDEX service.
4.
Issue 02 (2008-11-20)
3-25
Fault Analysis
The firewall of the server may prevent other computers from accessing the service port of the HEDEX.
Procedure
1. Check whether the service is started. if not, start it by referring to Starting the HEDEX service.
l l
If the service is started, go to 2. If the service is not started, start it on a server. If the problem persists, go to 2.
NOTE
2.
Check whether the HEDEX access address is correctly entered in the browser.
You can obtain the access address of the HEDEX from the HEDEX administrator.
l l
If the address is correct, go to 3. If the address is incorrect, enter the access address of the HEDEX again. If the problem persists, go to 3.
3.
Check whether the HEDEX service port of the firewall on a server is started. The steps are as follows: (1) On the server, choose Start > Settings > Control Panel > Windows Firewall. The Windows Firewall dialogue box is displayed. Click the Advanced tab. In the Network Connection Settings field, select Local Area Connection. Then click Settings. The Advanced Settings dialogue box is displayed. (2) In Advanced Settings, click the Services tab. Then click Add. The Services Settings dialogue box is displayed. In Services Settings, enter proper information in related text boxes and then click OK. See Figure 3-30. The external port number and internal port number for this service are the service port number set when the HEDEX is installed, for example, 52199.
3-26
Issue 02 (2008-11-20)
Figure 3-30 Configuring the port number for the HEDEX service
Issue 02 (2008-11-20)
3-27
Fault Analysis
The gateway of the computer in the LAN cannot access the server.
Procedure
1. Check whether the service is started. if not, start it by referring to Starting the HEDEX service.
l l
If the service is started, go to 2. If the service is not started, start it on the server. If the problem persists, go to 2.
2.
Check whether the HEDEX access address is correctly entered in the browser of a computer in the LAN.
NOTE
You can obtain the access address of the HEDEX from the HEDEX administrator.
l l
If the address is correct, go to 3. If the address is incorrect, enter the access address of the HEDEX again. If the problem persists, go to 3.
3.
To modify the LAN proxy in the browser of the computer in a LAN, do as follows: (1) On the browse interface, choose Tools > Internet Options. The Internet Options dialogue box is displayed. (2) In Internet Options, click the Connections tab. Then click LAN Settings. The Local Area Network (LAN) Settings dialogue box is displayed. (3) In Local Area Network (LAN) Settings, click Advanced. The Proxy Settings dialogue box is displayed. Under Exceptions, enter the IP address of the server. See Figure 3-32.
3-28
Issue 02 (2008-11-20)
Issue 02 (2008-11-20)
3-29
Issue 02 (2008-11-20)
4-1
Procedure
Step 1 Insert the HEDEX installation CD in the drive. Step 2 Run the command mkdir /mnt/cdrom to create a mounting directory. Step 3 Run the command mount -t iso9660 /dev/hdc /mnt/cdrom to mount the CD. Step 4 Create a HEDEX installation directory. For example, if /home/huawei exists in the system, run the command mkdir /home/huawei/ hedex to create a hedex subdirectory under /home/huawei. Step 5 Decompress the installation file into the installation directory. Run the command unzip /mnt/cdrom/hedex.zip -d {install_path} (use {install_path} to represent the installation path in all the commands in Linux and Solaris). For example, to decompress the installation file into /home/huawei/hedex, run unzip /mnt/cdrom/hedex.zip d /home/huawei/hedex. Step 6 Modify the four files in the format of .sh under {install_path}/bin. 1. 2. Modify hedex_start.sh. Set the value of hedex_install_path of hedex_start.sh to the installation path. Modify hedex_stop.sh. Set the value of HEDEX_ROOT of hedex_stop.sh to {install_path}/server. Set the value of JAVA_HOME to {install_path}/javasoft/jdk;. 3. 4. Modify hedex_kill.sh. Set the value of HEDEX_ROOT of hedex_kill.sh to {install_path}/server. Modify hedex_monitor.sh. Set the value of HEDEX_ROOT of hedex_monitor.sh to {install_path}/server. Step 7 Modify setup.xml under {install_path}/conf.
l l
Set the value of install_path to the HEDEX installation path. Set the value of install_language as required. install_language determines the language displayed on the HEDEX interface. zh indicates Chinese, and en indicates English. Set the value of db_url to jdbc:derby:{install_path}/database, for example, dbc:derby:/ home/huawei/hedex/database. Set the value of library_default_dir to {install_path}/libraries, for example, /home/ huawei/hedex/libraries. Set library directories of HEDEX under <library_path>. Libraries under these directories are displayed in the HEDEX. You can set up to 10 directories. This is optional.
----End
4-2 Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. Issue 02 (2008-11-20)
Result
After the HEDEX is installed on the Linux or Solaris, users in the LAN can access the HEDEX through http://IP address of the server:52199/hedex. For example, if the IP address of the server is 10.71.136.179, the HEDEX address is http://10.71.136.179:52199/hedex.
Procedure
Step 1 Add executable rights to the following files:
l l l
All the files under {install_path}/bin All the files under {install_path}/javasoft/jdk/bin All the files under {install_path}/javasoft/jdk/jre/bin
NOTE
In the specified directory, run the command chmod +x * to add executable rights to all the files under this directory.
l
All the files with the suffix of .sh under {install_path}/server/bin (by running the command chmod +x *.sh)
Step 2 Run hedex_start.sh under {install_path}/bin. Run {install_path}/bin/hedex_start.sh. For example, if HEDEX is installed in /home/huawei/ hedex, run /home/huawei/hedex/bin/hedex_start.sh. ----End
Prerequisite
The HEDEX service is started.
Procedure
Run hedex_stop.sh under {install_path}/bin. Run {install_path}/bin/hedex_stop.sh. For example, if the HEDEX is installed in /home/ huawei/hedex, run the command /home/huawei/hedex/bin/hedex_stop.sh. ----End
Prerequisite
HEDEX is not started.
Procedure
Run rm -r {install_path} to uninstall the HEDEX. For example, if the HEDEX is installed in /home/huawei/hedex, run rm -r /home/huawei/ hedex. ----End
4.5 Troubleshooting
This topic describes the troubleshooting when you install or run the HEDEX in Linux and Solaris. 4.5.1 "internal error" is Displayed when Users Access the HEDEX on a Server
4.5.1 "internal error" is Displayed when Users Access the HEDEX on a Server
Fault Description
When a user in the LAN accesses the HEDEX, "internal error" is displayed in the HEDEX. In the server installed with the HEDEX, check the log file catalina.out. The record shown in Figure 4-1 is displayed. Figure 4-1 Log information
Fault Analysis
In the operating system (OS) of the installation server of the HEDEX, the value of the parameter open files is too small. You need to set the value to a larger number. The value 10000 is recommended.
Procedure
1. If the HEDEX installation server is installed with SUSE Linux Enterprise Server 9, add the following information to limits.conf under /etc/security/:
Huawei Proprietary and Confidential Copyright Huawei Technologies Co., Ltd. Issue 02 (2008-11-20)
4-4
If the parameter soft nofile or hard nofile already exists in limits.conf, modify the value.
If the OS is Solaris 10, add the following information to limits.conf under /etc/system/:
l l
2.
Issue 02 (2008-11-20)
4-5