1Network Infrastructure Inventory [N(i)²], Inc.

Installation GuideInstallation Guide

The N(i)² ™ SuiteThe N(i)² ™ Suite

2

© 2007 Network Infrastructure Inventory [N(i)²], Inc. All rights reserved.

Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means, or for any purpose, without the express written permission of Network Infrastructure Inventory [N(i)²], Inc.

N(i)², Inc. considers information included in this documentation to be proprietary and confidential. Use of this documentation is subject to the terms and conditions set forth in the appropriate end-user license agreement or non disclosure agreement for the software and the proprietary and restricted rights notices included in this documentation.

Information in this document is subject to change without notice. Network Infrastructure Inventory [N(i)²], Inc. may have patents, patent applications, trademarks, copyrights, or other intellectual property covering subject matter in this document. Except as expressly provided in any written license agreement from Network Infrastructure Inventory [N(i)²], Inc., the furnishing of this document does not give you a license to these patents, trademarks, copyrights or other intellectual property.

N(i)² and the N(i)² logo are either registered trademarks or trademarks of Network Infrastructure Inventory [N(i)²], Inc. in Canada and/or other countries. The names of actual companies and products mentioned herein may be the trademarks of their respective owners.

Contacting N(i)²If you need technical support regarding the use of the software, please contact N(i)² support team by e-mail at support@ni2.com.

This edition applies to version 2.5 of the N(i)² ™ Suite, until the next release.

Copyrights

Inst

alla

tion

3

Contents

PrerequisitesIntroductionInstallation CDInstalling The N(i)² Server

• Installing Java JDK• Installing and Configuring Jboss Application Server• Virtual Memory and Optional Parameters • Running the Server as a Service • Running the Server Manually

Updating The N(i)² Server Installing The N(i)² License File Creating The N(i)² Lucene IndexInstalling The N(i)² ClientStarting The N(i)² Client

Inst

alla

tion

4

Prerequisites

Prerequisites

Before you start, please make sure that:� You are in possession of the required installation software and documentation.� You are in possession of the required License files, which you can obtain by

contacting N(i)2 support at the following address: support@ni2.com .� You have signed an End User License Agreement.

Conventions

<YourJBossHome> : The path to your JBoss directory (Ex: C:\JBoss).

<YourRdbms> : Identifies the RDMS you are using (Ex: ORA for Oracle, POS for postgres).

hostname : The name of the host where the application server is deployed.

Important Notices

Avoid copying from the present installation document and pasting into configuration or properties files.

Avoid editing a file in a Windows environment and then transferring it to a Unix or Linux environment (characters are often altered during such transfer).

Inst

alla

tion

5

Introduction

The N(i)² Suite is a client-server application that uses Java.

This document describes the steps required to install the N(i)² Application Server and the N(i)² Client Application. This guide applies to both products even if some figures and/or explanations are taken only from The N(i)² Suite installation procedure.

To install the product, you can use the Installation CD provided by N(i)² or the ISO image downloaded from the N(i)² FTP. Please refer to the next chapter for detailed information about the content of the CD.

In this guide you will also find a description of each of the steps required for the installation of the server and client platforms, as well as information on how to start and stop the server (manually or as a service), and how to start the client.

Inst

alla

tion

6

Installation CD

The N(i)2 Installation CD contains the following files and directories:

Jboss directory� Jboss-40.5.GA (Jboss Application Server directory)� Jboss_Service_Install (Jboss Service Installation Directory)� <YourRdbms>NI2 (Directory containing N(i)2 Conf, Lib, Properties and

Deploy files to be added to the Jboss installation for your specific Rdbms)

Databases directory� Demo (Directory containing a set of start-up demo databases:

N(i)2Demo_<YourRdbms>.zip) � Empty (Directory containing a set of start-up empty databases:

DB_EMPTY_<YourRdbms>.zip)

Java directory� Client (Directory)

• jre-1_5_x.exe. The Java JRE is requiered to run the N(i)2 rich client.• jai-1_1_3-x-jdk.exe. The Java(TM) Advanced Imaging (Windows JRE

Install)

� Server (Directory) • jdk-1_5_x.exe. The Java SDK is required to run the N(i)2 Server.• jai-1_1_3-x-jdk.exe. The Java(TM) Advanced Imaging (Windows

JDK Install)

Note: If both the N(i)2 Client and the N(i)2 Server will run on the same machine, please install JDK, JRE and their respective JAIs.

Note: You can download JDK/JRE versions from:http://java.sun.com/j2se/1.5.0/download.jsp

Note: You can download JAI versions from: http://java.sun.com/products/java-media/jai/downloads/download-1_1_3.html

Inst

alla

tion

7

Installation CD (cont.)

The Ni2 Suite Installation Guide

Ni2 Suite Installation Guide v.x.x.pdf

Client API Directory

Ni2ApiClient-x.x..zip (Contains N(i)2 API related files)

Patch_Tool Directory

Ni2PatchTool-x.x.zip (Contains required files to patch an existing N(i)2 database)

Docs Directory

N(i)2 documentation including user guides

Inst

alla

tion

8

Installing the N(i)² Suite Server

Installing Java JDKPlease note that step 1 may not be required if you already have Java JDK 1.5.x. If you have a previous version of Java - JDK 1.4.x -, you should remove it first. When reinstalling JDK, make sure to complete each step as in your first installation.

Linux:

1. From the Java directory on the installation CD, execute the Java Installer (file: jdk 1_5_0_0x-linux-i586-rpm.bin) as the root user and follow the installation procedure.

2. Add the JAVA_HOME environment variable. It has to be set to your Java installation dir. (Ex: Name=JAVA_HOME ; Value=/usr/java/jdk1.5.0_0x).

3. From the Java directory on the installation CD, execute the Java™Advanced Imaging Installer (file: jai-1_1_3-alpha-lib-linux-i586-jdk.bin)as the root user.

Windows:1. From the Java directory on the installation CD, execute the Java Installer

(file: jdk-xxx-windows-i586-p.exe) and follow the installation procedure.

2. Add the JAVA_HOME environment variable. It has to be set to your Java installation dir. (Ex: Name=JAVA_HOME ; Value=C:\java\jdk1.5.0_0x).

3. From the Java directory on the installation CD, execute the Java™Advanced Imaging Installer (file: jai-1_1_3-alpha-lib-windows-i586-jdk.exe).

4. After the installation, uncheck the “Java Automatic update” option from your Control Panel / Java.

Notes:• Use the Java installers default settings.• Use jre and jai for jre for the rich client installations.

Inst

alla

tion

9

Installing and Configuring Jboss Application Server1. Extract JBoss.zip file in a dedicated directory (<YourJBossHome>). 2. Extract <YourRdbms>NI2.zip file in your (<YourJBossHome>/server)

directory.3. Configure Jboss in order to use the client and the Slide databases that you

have defined (see Database Installation documentation).4. Make sure that the file

<YourJBossHome>\server\<YourRdbms>NI2\deploy\<YourRdbms>-ds.xml contains the name of the 2 databases that you will connect to.

Note: This file varies in name to identify what rdbms engine is being used and the connection string also varies from one rdbms to another.

Postgres-ds.xml example<datasources>

<local-tx-datasource><jndi-name>ni2</jndi-name><connection-url>jdbc:postgresql://hostname:5432/client db</connection-url> <driver-

class>org.postgresql.Driver</driver-class><user-name>postgres</user-name><password>postgrespassword</password>

</local-tx-datasource>

<local-tx-datasource><jndi-name>ni2Slide</jndi-name>

<connection-url>jdbc:postgresql://hostname:5432/ni2Slide</connection-url><driver-class>org.postgresql.Driver</driver-class><user-name>postgres</user-name><password>postgrespassword</password><min-pool-size>5</min-pool-size>

</local-tx-datasource></datasources>

5. Make sure that the file YourJBossHome>\server\<YourRdbmsNI2\ni2config.properties is configured properly.

Installing the N(i)² Suite Server (cont.)

Inst

alla

tion

10

Installing the N(i)² Suite Server (cont.)

ni2config.properties example

hibernate.sessionfactory.jndi=java:/hibernate/SessionFactorylucene.jms.queueconnectionfactory.jndi=ConnectionFactorylucene.jms.queue.jndi=queue/B

## At application boot time, nber of attempts to reach Ni2 Repository Serverni2.repository.nber.access.attempts=3## At application boot time, pause time (msec) between attemptsni2.repository.between.access.attempts.wait.time=2000

ni2.server.hostname=hostnameni2.server.port.jndi=1099ni2.server.port.http=8080ni2.server.jndi.protocol=jnpni2.server.http.protocol=http

## Location from the Ni2 WebDAV repository files location http://hostname:8080/slide/files and any subdirni2.repository.url.home=http://hostname:8080ni2.repository.files.root=/slide/filesni2.repository.files.attachments=/attachmentsni2.repository.files.config=/importexportni2.repository.files.import=/importni2.repository.files.export=/exportni2.repository.files.specs=/specsni2.repository.files.instances=/instancesni2.repository.files.associations=/associationsni2.repository.files.rights=/Config/RightsConfig.xmlni2.repository.files.license=/Config/License.xml

## Location from the Ni2 WebDAV repository files location http://hostname:8080/slide/files ni2.scheduling.engine.job.config=/Config/jobs.xml

## Indicate here is the Ni2 Search Engine must refresh it's indexes at server startup (takes some times!!)ni2.search.engine.refresh.index=false

## Ni2 Directory LDAP Server portsni2.directory.ldap.port=10389ni2.directory.ldaps.port=10636

## Ni2 Application Version## External modification won't be taken into accountni2.version=2.5

Inst

alla

tion

11

Installing the N(i)² Suite Server (cont.)

Virtual Memory and Optional parameters

In your Jboss directory, go to: <YourJBossHome>\bin.

Linux:

Open your run.conf file using an editor such as gedit or vi. Or,

Windows:

1. Open your run.bat file using an editor such as TextPad or Notepad.

2. Search for the line below and modify the parameters <JBOSS_HOME> and <YourRdbms> to your specific environment values:

set JAVA_OPTS=%JAVA_OPTS% -Dni2.config.properties=<JBOSS_HOME>/server/<YourRdbms>NI2/ni2config.properties -Xms256m -Xmx1024m -XX:MaxPermSize=256m

Note: These optional parameters apply only if your machine has at least 1GB of RAM (recommended). Otherwise, please write:

Dni2.config.properties=<JBOSS_HOME>/server/<YourRdbms>NI2/ni2config.properties -Xms128m –Xmx512m -XX:MaxPermSize=128m

This step might already be included in the Jboss version that was extracted from the CD delivered by N(i)2.

Inst

alla

tion

12

Installing the N(i)² Suite Server (cont.)

Running the Server as a Service

Important Notice

Please avoid running the server as a service before it functions properly by manual startup.

An installation procedure is available for automatic startup of the N(i)2 server, on the Jboss_Service_Install directory of the CD. Follow these steps to install the N(i)2 server as a service:

Linux:1. Edit the Jboss file in the Jboss_Startup_Install directory on the CD, and

replace all <JBOSS install directory> entries by <YourJbossHome> (path to your Jboss installation directory). Replace the <RdbmsNI2> by <YourRdbms>ni2.

2. Save and close the file.

3. Run the Install_Jboss_Service.sh script by typing the following command as the root user. Command syntax: ./Install_Jboss_Service.sh .

Windows:1. Copy the Jboss_Service_Install directory from the Jboss directory on the

CD, to <YourJbossHome>.

2. In a command prompt (Dos shell), run the JBossService.bat file from <YourJbossHome>\ Jboss_Service_Install\Windows.

3. Enter the path to your Java home directory.

4. Enter the path to your Jboss home directory.

5. Enter the name of your N(i)2 Server directory: <YouRdms>ni2 (posni2, orani2, mssqlni2, db2ni2).

Inst

alla

tion

13

Installing the N(i)² Suite Server (cont.)

Running the Server ManuallyIf you have decided to run the server as a service, you do not have to execute the steps described in this section. However, if you wish to start and stop the server manually, you must read the following:

To start the N(i)² server

Linux:

Enter the following command:<YourJBossHome>/bin/run.sh –c <YourRdbms>ni2

Windows:

In a command prompt (DOS Shell) enter the following command:<YourJBossHome>\bin\run.bat –c <YourRdbms>ni2

To stop the N(i)² server

Linux:

Enter the following command:<YourJBossHome>/bin/shutdown.sh –c <YourRdbms>ni2

Windows:

In a command prompt (DOS Shell) enter the following command:<YourJBossHome>\bin\shutdown.bat –c <YourRdbms>ni2

Inst

alla

tion

14

Updating the N(i)2 Server

To install the Ni2 update

1. Remove from <YOUR JBOSS HOME>\server\<YourRdbms>ni2\deploy folder all files starting with NI2.

2. Backup your <YOUR JBOSS HOME>\server\<YourRdbms>NI2\deploy\<YourRdbms>-ds.xml file.

3. Backup your <YOUR JBOSS HOME>\server\<YourRdbms>ni2\ni2config.properties file.

4. Download the “ni2_<YourRdbms>nI2_update.zip” file from the N(i)² FTP server

5. Extract the Jboss directory content of the zip file into the <YourJBossHome>\server directory. It will replace all files that have changed since the previous build in your “Server” directory, and will provide you with the new update.

6. Restore the previously backed up files to their original location.

Notes:• You will need to patch your existing databases with the N(i)² Patch tool.

The patch tool is located either in the Ni2PatchTool-x.x.zip file of Patch_Tool directory on the installation CD, or on the N(i)2 FTP server. You will need to edit the patch.properties file according to your specific host and rdbms installation.

• To patch your existing databases:1. Extract the Ni2PatchTool-x.x.zip file in the location of your choice2. Edit the patch.properties file according to your environment.

Windows:In a command prompt (DOS Shell) launch patch_batch.cmd from the Ni2PatchTool-x.x directory Linux:Launch patch_batch.sh from the Ni2PatchTool-x.x directory.

Inst

alla

tion

15

Updating the N(i)2 Server (cont.)

Notes (cont.):• If you use the N(i)2 API: When installing a server update, you must also

download the N(i)² API client files and install them into the development environment library directory of the third party application.

Inst

alla

tion

16

Installing the N(i)² License File

The N(i)2 license is stored in the Slide repository. You must upload these 2 files to the Slide repository : License.xml and RightsConfig.xml.

Linux:

1. Run the SkunkDAV.jar from the CD.2. Select Connect from the File menu.3. In the dialog box, enter the URL to your Slide repository, which is usually

http://hostname:8080/slide, and click Connect.4. Select the files/config directory.5. Select Upload from the File menu.6. Select the License.xml and RightsConfig.xml to upload, and click Open.

Windows:

1. Add a new network place from My Network Places.2. In the first page of the Wizard, click Next.3. Select Choose another network location.4. In the dialog box, enter the URL to your slide repository, which is usually

http://hostname:8080/slide, and click Next.5. Type a descriptive name for the new network place.6. Click Finish.7. Copy the License.xml and RightsConfig.xml files to the new netwok place in

the files/config directory.

Note: If you are unable to create a new network place because of security settings in your windows environment, you can run SkunkDAV.jar, which is included on the installation CD, and follow the procedure described above.

Inst

alla

tion

17

Creating the N(i)² Lucene Index

Lucene is a searching service used in the N(i)2 Suite. It is necessary to initialize it once the server has been started.

Note: This needs to be done only once, after the initial installation. On occasion, such as after major upgrades, it might be necessary to initialize it again. if so, it will be specified in the Release Notes.

1. In a web browser, type the following URL: http://hostname:8080/jmx-console/HtmlAdaptor?action=inspectMBean&name=user%3Aservice%3DNi2CoreService%2Cname%3DNi2CoreService

2. About half way down the page there is the following section:void makeLucenceIndex()MBean Operation.

3. Click the Invoke button.

When the creation of the Lucene index is completed, the system will bring you to a successful completion page.

I n v o k e

Inst

alla

tion

18

Installing The N(i)² Rich Client

1. Make sure the N(i)² Server is up and running.

2. Make sure that Java JRE version 1.5.0_0x and JAI version 1.1.3_jre are installed on the client workstation. These can be found on the N(i)2 CD.

3. Open a Internet browser and type : http://hostname:8080/ni2ws/

4. Follow the instructions to install the client.

5. Once the installation is done, a shortcut is created on your desktop:

Inst

alla

tion

19

Starting The N(i)² Rich Client

1. Make sure the N(i)² Server is up and running.

2. Execute the N(i)² Client Application using the WebStart shortcut:

Enter your User Name and Password

1Click Login2 You can always

cancel the launch of the N(i)2 Suite by clicking Exit

Click Clear to empty the console

Click Copy to copy the content of the console

Click Closeto shutdown the console