NED 6.

0 Administrator's Guide

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

1 (19)

NED 6.0 Administrator's Guide

The information in this document is subject to change without notice and describes only the
product defined in the introduction of this documentation. This documentation is intended for the
use of Nokia Siemens Networks customers only for the purposes of the agreement under which
the document is submitted, and no part of it may be used, reproduced, modified or transmitted in
any form or means without the prior written permission of Nokia Siemens Networks. The
documentation has been prepared to be used by professional and properly trained personnel,
and the customer assumes full responsibility when using it. Nokia Siemens Networks welcomes
customer comments as part of the process of continuous development and improvement of the
documentation.
The information or statements given in this documentation concerning the suitability, capacity, or
performance of the mentioned hardware or software products are given as is and all liability
arising in connection with such hardware or software products shall be defined conclusively and
finally in a separate agreement between Nokia Siemens Networks and the customer. However,
Nokia Siemens Networks has made all reasonable efforts to ensure that the instructions
contained in the document are adequate and free of material errors and omissions. Nokia
Siemens Networks will, if deemed necessary by Nokia Siemens Networks, explain issues which
may not be covered by the document.
Nokia Siemens Networks will correct errors in this documentation as soon as possible. IN NO
EVENT WILL NOKIA SIEMENS NETWORKS BE LIABLE FOR ERRORS IN THIS
DOCUMENTATION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL,
DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT
NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESS
OPPORTUNITY OR DATA, THAT MAY ARISE FROM THE USE OF THIS DOCUMENT OR THE
INFORMATION IN IT.
This documentation and the product it describes are considered protected by copyrights and
other intellectual property rights according to the applicable laws.
The wave logo is a trademark of Nokia Siemens Networks Oy. Nokia is a registered trademark of
Nokia Corporation. Siemens is a registered trademark of Siemens AG.
Other product names mentioned in this document may be trademarks of their respective owners,
and they are mentioned for identification purposes only.
Copyright Nokia Siemens Networks 2009. All rights reserved.

2 (19)

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Contents

Contents
Contents 3
1
1.1
1.2

Introduction 5
Introducing Administrator's Guide
Conventions 6

2
2.1
2.2
2.3

Technical Overview 7
Requirements 7
Technologies used in NED 7
Compatibility between NED libraries and software versions

3
3.1
3.2

User Management 9
Changing Admin group manually 9
Cloning user management settings to other servers

4
4.1
4.2
4.3
4.4

Installing and Using NED 11

Using NED 6.0 libraries from CD-ROM 11
Installing NED 5.1/5.1+ libraries under NED 6.0 13
Running NED 5.1/5.1+ at the same time with NED 6.0
Deploying NED 6.0 manually to Tomcat 15

5
5.1

Security 17
Enabling secure network connection

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

10

14

17

3 (19)

NED 6.0 Administrator's Guide

4 (19)

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Introduction

Introduction

1.1

Introducing Administrator's Guide

NED is a browser concept used for delivering Nokia Siemens Networks
customer documentation. It enables unified access to Nokia electronic
documentation via one interface. NED is developed in phases (NED 5.0,
NED 5.1, NED 5.1+, NED 5.2 - NED 5.5 - NED 6.0) and the development
is largely based on customer feedback.
The NED 6.0 Administrator's Guide is an additional document to NED 6.0
User Guide. Administrator's Guide provides technical information and step
by step instructions about various maintaining and troubleshooting tasks
usually performed by the system administrators. Topics like getting started
with NED or descriptions of NED user interface components are not in the
scope of this document. Please refer to the NED 6.0 User Guide for more
information about those topics and NED 6.0 in general.
Reader of this document should have basic knowledge about the servlet/
JSP containers, Web technologies, Java and NED. Reader is also
expected to be familiar with the NED 6.0 User Guide.
The guide is organized as follows:

DN0462345
Issue 2-0 en

Chapter 1 contains general information about this guide.

Chapter 2 gives an overview of the technologies used in NED.

Chapter 3 explains some seldom needed user management tasks.

Chapter 4 contains installation and usage information not covered in

the NED 6.0 User Guide.

Chapter 5 discusses on NED related security issues.

# Nokia Siemens Networks

5 (19)

NED 6.0 Administrator's Guide

1.2

Conventions
This section describes some common conventions that are used
throughout the guide.
<ROOT> is used to represent the path of the NED installation directory.

When new NED installation is done with the NED installation program in
Windows, the default value of the <ROOT> is C:\Program Files\NSN\NED
6.0.
<NED> is a path of the NED software in servlet/JSP container. When new

NED installation is done with the installation program in Windows, the

default value of <NED> is <ROOT>\Server\webapps\NED.

6 (19)

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Technical Overview

Technical Overview
This chapter gives a quick overview on the technologies used in NED and
compatibility between NED software and library versions.

2.1

Requirements
To install and use NED 6.0, the following software are required:

2.2

Web browser: Firefox 1.5 (or greater), Internet Explorer 6.0 (or
greater), or Netscape Navigator 7.01 (or greater).

Java 1.3.1 (or greater).

Servlet/JSP container that supports Servlet Specification 2.2 (or

later) and JavaServer Pages Specification 1.1 (or later).

Technologies used in NED

NED uses several public technologies, like XML, servlets and JSPs, and
various open source products. For example, Apache Jakarta Tomcat is
used as a servlet/JSP container when NED is installed with the installation
program, Apache Jakarta Lucene is used as a search engine in NED, and
Saxon and Apache Xerces are used to process XML files.

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

7 (19)

NED 6.0 Administrator's Guide

2.3

Compatibility between NED libraries and software

versions
Besides using libraries made for it, NED 6.0 can also use libraries
originally made for NED 5.2, NED 5.3, NED 5.4, NED 5.4+ and NED 5.5.
Libraries of the older NED versions than NED 5.2 are not compatible with
NED 6.0 and cannot be installed to NED 6.0. However, older NED libraries
can be linked to NED's start page.
The following table summarizes the compatibility information between the
different NED software and library versions.

5.0
Library
NED 5.0
Software

5.1
Library

5.1+
Library

5.2
Library

5.3
Library

5.4
Library

5.4+
Library

5.5
Library

6.0
Library

NED 5.1
Software

NED 5.1+
Software

NED 5.2
Software

link

link

link

NED 5.3
Software

link

link

link

NED 5.4
Software

link

link

link

NED 5.4+
Software

link

link

link

NED 5.5
Software

link

link

link

NED 6.0
Software

link

link

link

X
link

8 (19)

NED libraries can be used in the specified software

version.
Libraries can be linked to the specified software
version.

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

User Management

User Management

3.1

Changing Admin group manually

Normally all user management tasks can be done by using Admin Tools
interface in NED. However, it is possible to accidentally lock down the NED
by removing Admin rights from all groups or by creating an empty group
that has all Admin rights. As a result nobody will have access to the Admin
Tools, which makes it impossible to install new libraries, change user
rights, or do other administrative tasks. In this case you need to manually
change the user management so that at least a one group has Admin
rights.
To set the Admin rights manually to a group:
1.

Stop NED server if it is running.

2.

Open file <NED>/WEB-INF/Group.xml in a text editor. The file should

look similar to the following:

<?xml version="1.0" encoding="utf-8"?>

<groupStore>
<group groupName="Admin" groupidStr="2" usersStr="administrator"/>
<group groupName="nokia" groupidStr="1" usersStr=""/>
<group groupName="public" groupidStr="0" usersStr=""/>
</groupStore>

3.

Copy groupidStr attribute value of the group you wish to give the
Admin rights to. In the example file in the previous step, the group is
named as "Admin" and the attribute value to be copied is "2".

4.

Open <NED>/WEB-INF/Access.xml file in a text editor. It should look

similar to the following:

<?xml version="1.0" encoding="utf-8"?>

<accessStore>
<access MARSStr="" adminGroupsStr="0" readGroupsStr="2,0" writeGroupsStr="2,0"/>
</accessStore>

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

9 (19)

NED 6.0 Administrator's Guide

5.

Paste the value copied in step 3 to adminGroupsStr attribute. In our

example, the resulting Access.xml file should look like this:

<?xml version="1.0" encoding="utf-8"?>

<accessStore>
<access MARSStr="" adminGroupsStr="2" readGroupsStr="2,0" writeGroupsStr="2,0"/>
</accessStore>

6.

Save Access.xml file and close both files.

7.

Start NED server and log in as an user of the group that was
selected in step 3.

The result of this change is that the users of the selected group have
Admin rights and can access to Administrative Tools page in NED.

3.2

Cloning user management settings to other servers

When multiple NED servers are being installed and the same user
management settings should be used in all servers, then it's practical to
just copy the settings from one server to others instead of creating the
same users and groups manually on every server. At first, install one NED
server and create the required user management settings on that server.
Then install the other servers and copy the following files to the new
servers:
.

Access.xml

Group.xml

User.xml

These files control the user management settings. They are located in
<NED>/WEB-INF directory.
Note that library installations cannot be copied from one server installation
to another. Instead the libraries have to be separately installed on every
NED server. However, the installed libraries can be located on a common
network drive where all servers can read and use them. Also, the different
servers can have different set of installed libraries.

10 (19)

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Installing and Using NED

Installing and Using NED

4.1

Using NED 6.0 libraries from CD-ROM

This section describes how to use NED so that the server is installed on a
local computer as usual but the library files are stored on a CD-ROM.
Normally NED libraries are installed either on the same computer with the
NED server or on a common network drive where the same library files
can be used by many users using their own NED installations. Third
option, presented in this section, is to use NED libraries from a CD-ROM.
This is practical, for example, when local disk space is limited and network
drives cannot be used.

Tip
The easiest way to start using a library from a CD-ROM in Windows is
to use NED installation program and select CD-ROM option when
library installation location is asked. See User Guide for more
information about installation.

Before starting: NED 6.0 must be installed and the server must be running.
Also, if you have already installed the same library you want to use from a
CD-ROM, you have to uninstall it.

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

11 (19)

NED 6.0 Administrator's Guide

1.

Locate the files of the library you want to use from the CD-ROM. You
can find the library files from NED installation CD-ROMs (see data
directory), or you can download them from NOLS.
NED 6.0 libraries consist of two or more ZIP files. The root file is
named as [library].zip where [library] is the short name or
code of the library (for example m11.zip is a root file). The library will
also have index ZIP, which is named [library]_index.zip
(m11_index.zip). If the library consists of more than two files, then
the rest of the files have the library name and a consecutive number
in their name (m11_1.zip, m11_2.zip, etc.).

2.

Write/burn all library files to a CD-ROM. You can write several

libraries to the same CD-ROM, but you need to install them
separately to the NED (see step 4).

3.

Insert CD-ROM to your computer and start NED.

4.

Install library to NED.

.
Go to Admin - Document Set Manager - Add New Library in
NED. Write the path of the root library file to Insert the library's
file name (only local files supported) field. You can also use
Browse button to get the path.
.
Remove tick from Copy library file(s) into NED to prevent NED
from copying the library files to the local hard drive.
.
Click Add Library button to start installation. After a little wait,
the new library should appear in the list of installed libraries.
You can now use the library in NED.
.
If you have multiple libraries you want to use on the CD-ROM,
then repeat this step to every library.

Note
You must have the library CD-ROM inside the drive when you want to
use the library installed in the way described here. Otherwise you will
get error messages, because NED cannot find the library files.

Warning
This installation method will still use some hard disk space to
install search index and library metadata. However, the amount of
disk space used is much less than when the complete libraries are
installed on the hard disk.

12 (19)

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Installing and Using NED

4.2

Installing NED 5.1/5.1+ libraries under NED 6.0

By default NED 5.1/5.1+ and NED 6.0 are installed under the separate
servers. However, sometimes it is useful to run different NED versions
under the same server. For example, administrative tasks are made easier
when there is only one server to take care of.

Note
The file paths and directories used in this section exist only when NED
has been installed with the installation program. If this is not the case,
then please check your server documentation to see how WAR files are
installed.

Before starting: NED 6.0 must be installed, but it should not be running.
Stop the server, if it is running.
1.

Locate the NED 5.1/5.1+ library file you want to install from the
installation CD-ROM. The file is located in data directory and is
named [library].war, where the [library] is the short name or
code of the library (for example, m11.war).

2.

Copy the WAR file to <ROOT>/Server/webapps directory under NED

6.0 installation.

3.

Start NED 6.0 and test the installed library by typing its URL address
to the browser's address bar. The address is of form http://
[computer]:[port]/[library] where [computer] is the name or
IP address of the computer the server is running on, [port] is the
HTTP port used by the server, and [library] is the short name or
code of the installed library. For example, the address is http://
localhost:43231/m12 when default NED installation is running on
the local computer and m12 library has been installed. Note that the
URLs are case sensitive.

4.

You can link he installed NED 5.1/5.1+ library to the NED 6.0 start
page. Refer to User Guide to see how to create the link.

Note
It is not possible to install NED 5.0 under the same server as NED 6.0.

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

13 (19)

NED 6.0 Administrator's Guide

4.3

Running NED 5.1/5.1+ at the same time with NED

6.0
NED 6.0 and NED 5.1/5.1+ use different servers and there might be TCP/
IP port conflicts if you try to run these servers at the same time. One way to
work around this problem is to install NED 5.1/5.1+ libraries to the NED 6.0
server (see section Installing NED 5.1/5.1+ libraries under NED 6.0). Other
way is to change the ports NED and Tomcat use to avoid the conflicts. The
procedure of changing the ports is described in this section.

Note
These instructions apply only in Windows environment and when NED
has been installed with the installation program.

1.

14 (19)

Make sure that you don't have a NED server running in you
computer. If you have, then stop the server. Also
.
Restart the computer.
or
.
Check and stop all running NED processes. In Windows use
Task Manager to stop the following processes:
.

NEDTray.exe

NED51Server.exe

NED53J.exe

2.

Start NED 5.1/5.1+.

.
NED 5.1:
.
After NED has been started, copy TCP/IP port number
from the URL address of the page. For example, in URL
http://127.0.0.1:41403/index.jsp the port number
is 41403. When URL doesn't have a port number, then
the default port 80 is used.
.
Stop NED 5.1 by choosing Stop NED5.1 Server from
Windows Start Menu.
.
NED 5.1+:
.
After NED has been started, go to NED Tray - Options
and copy the port number from the text field.
.
Stop NED 5.1+ by choosing Exit NED5 Admin Console
from NED Tray.

3.

Start NED 6.0.

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Installing and Using NED

After NED has started, go to NED Tray - Options and check if

the port number here is the same as the port number in NED
5.1/5.1+. If the port numbers are identical, then change this
port number to something else (for example from 43231 to
43254).
Stop NED 6.0 by choosing Exit NED Tray from NED Tray.

Now different NED versions use the different TCP/IP port numbers and
both NEDs can be run at the same time.

4.4

Deploying NED 6.0 manually to Tomcat

This section describes how NED software can be manually deployed/
installed to a Tomcat servlet/JSP container. The most common method for
installing NED software is to use installation program delivered in NED
installation CD-ROM and let it take care of the installation details.
However, the installation program works only under Windows operating
system and it cannot be used, for example, when you need to install NED
to a Unix environment, or when you want to install NED to an existing
server. In these cases you have to manually install NED software to the
server.

Note
The instructions apply only to Tomcat. Other servers may use different
deployment processes.

Follow these steps to deploy NED to Tomcat:

DN0462345
Issue 2-0 en

1.

Shutdown Tomcat, if it's running. Normally this is done by executing

<TOMCAT>\bin\shutdown.bat (in Windows) or <TOMCAT>/bin/
shutdown.sh (in Unix). <TOMCAT> variable refers to the root directory
of the Tomcat installation.

2.

Copy NED.war file to <TOMCAT>/webapps directory. You can find the

NED.war from data directory on NED installation CD-ROM.

3.

Start Tomcat by executing <TOMCAT>\bin\startup.bat (in

Windows) or <TOMCAT>/bin/startup.sh (in Unix). Tomcat will
automatically extract NED.war and deploy the NED software during
the startup.

# Nokia Siemens Networks

15 (19)

NED 6.0 Administrator's Guide

NED can be accessed from a Web browser after Tomcat has finished its
startup procedure. Browse to URL http://localhost:8080/NED to test
NED. Note that the URLs are case sensitive.

Note
URL http://localhost:8080/NED works only when the Web browser
and the Tomcat installation are running on the same computer and
when Tomcat has been configured to accept HTTP requests to port
8080. The default configuration of Tomcat is to accept these requests.
Please refer to the Tomcat documentation for more information about
the configuration details.

16 (19)

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Security

Security

5.1

Enabling secure network connection

By default all data send between NED server and web browser is sent as
clear text, i.e. the connection is not secure. However, sometimes the
default behavior is not desirable and instead the secure connection is
required. In these cases you can manually configure NED to use Secure
Socket Layer (SSL) technology to encrypt all data being transmitted
between the NED server and the browser.
Normally, when NED is installed as a local installation, or it is used inside
the company intranet without full user management, the secure connection
is not needed. Consider enabling secure connection when
.

Full NED user management is active and passwords and user

names must be encrypted.

Notes in NED are used to store confidential data.

Connections are established over untrusted network.

It is recommended to consult local security policies before enabling the

secure connection in NED.
Configuration overview
This section contains an overview of installation and configuration actions
needed to enable secure connection support in NED. Some of the actions
are specific to NED and some are specific to Tomcat 5.0.28 servlet/JSP
container delivered with NED 6.0. Please refer to a SSL Configuration
HOW-TO (http://jakarta.apache.org/tomcat/tomcat-5.0-doc/ssl-howto.html)
in Tomcat documentation for more information about Tomcat specific
actions and SSL support in general. Local copy of the HOW-TO guide can
also be found on the NED CD-ROM (see file docs/server/ssl-howto.
html).

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

17 (19)

NED 6.0 Administrator's Guide

Directories in the following instructions are relative to the NED installation

directory when NED has been installed with the Windows installation
program. The directories may be different when NED has been installed
manually on a Windows or on a Unix machine.

Note
Consult your server manual on installing and configuring secure
connections, if you are using some other servlet/JSP container or some
other version of Tomcat than the one delivered with NED.

Follow these steps to install and configure secure connection:

.

Stop NED server before changing the configuration.

Download Java Secure Socket Extension (JSSE) from Sun's

website: http://java.sun.com/products/jsse/. By default NED uses
Java 1.3.1 and JSSE is not included in that distribution. At the time of
this writing, the latest available version of JSSE is 1.0.3.

Install JSSE. It is recommended to install JSSE as an installed

extension by copying JAR files from JSSE lib directory (jcert.jar,
jnet.jar, and jsse.jar) to directory <NED>/Javasoft/JRE/lib/
ext.

Create a certificate keystore with keytool command-line utility or

install an existing certificate. The keytool utility is delivered with Java
SDKs and JREs. It can also be found from <NED>/Javasoft/JRE/
bin directory in NED installation. See Tomcat and keytool
documentation for usage instructions.

Note
Nokia Siemens Networks doesn't provide a registered Certificate from
Certificate Authority with NED. Contact your local security organization
to get a registered Certificate or generate a local "self-signed"
Certificate with the keytool utility.
.

Remove comment delimiters around the SSL connector in the

server.xml file (in directory <NED>/Server/conf). This enables
server to accept secure connections in port 8443. See Tomcat
documentation for more instructions.
If you want to disable normal HTTP access to NED, you can
comment out HTTP connector in the server.xml file.

18 (19)

# Nokia Siemens Networks

DN0462345
Issue 2-0 en

Security

Remove comment delimiters around the <security-constraint>

element in the web.xml file (in <NED>/Server/webapps/NED/WEBINF directory) to force NED to use the secure connection.

Start NED server.

Note
After the secure connection is enabled, give users a direct link to
HTTPS port instead of using the old HTTP port. If you are using the
server functionality to forward HTTP connections to HTTPS port, then
some web browsers (notably Internet Explorer) fail to open the start
page of the NED at the beginning of a new session. Refreshing the
page in the browser fixes this problem.

Warning
NED Tray will not work correctly after the changes. For example, it
might not detect that the server has started or it cannot open a
web browser. You must manually update a NED configuration file
to make NED Tray work correctly:
.

Open <NED>/Util/ned52.ini file in a text editor.

Update url key to contain correct schema (https) and port values.
For example, change value http://127.0.0.1:43231/NED to
https://127.0.0.1:8443/NED and save the file.
Also note that changing TCP/IP port in NED Tray changes only the
HTTP port and not the HTTPS port.

DN0462345
Issue 2-0 en

# Nokia Siemens Networks

19 (19)