Installation Guide

Trademarks
CARIS software and the CARIS logo are registered trademarks of CARIS.
Other brands and product names are registered trademarks or trademarks of their respective
holders.

CARIS CARIS bv CARIS USA

(Global Headquarters) PO Box 47 3239A Corporate Court
264 Rookwood Avenue Mgr. van Oorschotstraat 13 Ellicott City, Maryland
Fredericton, New Brunswick Heeswijk, 5473 ZG UNITED STATES
CANADA NETHERLANDS 21042
E3B 2M2
Phone: +31 (0)413 296 010 Phone: 1 (410) 418-8907
Phone: 1 (506) 458-8533 Fax: +31 (0)413 296 012 Fax: 1 (410) 418-8957
(English/French/Spanish) Email: sales@caris.nl Email: carisusa@caris.com
Fax: 1 (506) 459-3849
www.caris.com
Email: info@caris.com
Assistance: support@caris.com

© CARIS 2002 - 2005

The material in this manual is for information purposes only and is subject to change without notice. CARIS assumes no
responsibility for any errors that may appear in this manual. CARIS hereby grants licensees of CARIS software the right to

18 September 2005
 Table of Contents

1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
IMPORTANT: Read Before Installing HPD . . . . . . . . . . . . . . . . .1-2
Installing CARIS HPD 2.3. . . . . . . . . . . . . . . . . . . . . . . . . . . .1-2
Minimum System Requirements . . . . . . . . . . . . . . . . . . . . . .1-2
Oracle Database Versions . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3
Operating System Versions . . . . . . . . . . . . . . . . . . . . . . . . . .1-3
About The NLS_NUMERIC_CHARACTERS Parameter . . . .1-4
Create or Upgrade Database . . . . . . . . . . . . . . . . . . . . . . . . . . .1-5
Create a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-6
Upgrade an Existing HPD Database . . . . . . . . . . . . . . . . . .1-13
Repeating the Upgrade Process . . . . . . . . . . . . . . . . . . . . .1-17
Installing HPD Client Applications. . . . . . . . . . . . . . . . . . . . . . .1-19
Setting Up HPD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-26
Using the Licencing Software . . . . . . . . . . . . . . . . . . . . . . . . . .1-27
Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-27
Updating a Licence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-28
Installing NetHasp on a Novell Network . . . . . . . . . . . . . . . .1-29

CARIS HPD Installation Guide iii

iv CARIS HPD Installation Guide
 1
Installation
Installation: IMPORTANT: Read Before Installing HPD

IMPORTANT: Read Before Installing HPD

Installing CARIS HPD 2.3

For CARIS HPD to operate correctly, there are two types of computer
setups required:
• Server computer: the computer on which the Oracle database and
the CARIS HPD database reside; this requires an Oracle database
installation and a CARIS HPD Server installation.
• Client computers: one or more computers on which the Oracle
client and CARIS HPD software programs reside; this requires the
Oracle database client installation and CARIS HPD Client
installation programs.

Minimum System Requirements

The following minimum system requirements are recommended for
running CARIS HPD software on a Windows server. If a non-Windows
server is used (for example, Solaris UNIX), follow the Oracle
recommendations for that server.

Server Workstation

Operating System Windows XP (SP1) Windows XP (SP1)

Windows 2000 (SP 2) Windows 2000 (SP2)
Windows NT 4 Server (SP4)
Processor Pentium III (or greater) Pentium III (or greater)
Memory 1 GB RAM 512 MB RAM
Hard Drive Space 40 GB Hard Drive 5 GB hard drive
Display 8 MB graphic card
(Minimum resolution of 1024 by 768 in 65 000 colours)
17-inch Colour Monitor
Drives CD-ROM Drive CD-ROM drive
(or networked PC)
Mouse Three-button mouse Three-button mouse
Notes Oracle Enterprise v9.2.0.4 Oracle Client v9.2.0.4
(Oracle 9i Spatial) (Oracle 9i Spatial)
Oracle.exe v9.2.0.4 patch
Network connected to server

1-2 CARIS HPD Installation Guide

 Installation: IMPORTANT: Read Before Installing HPD

You must have at least 100 MB of available disk space on the

c:\ drive to ensure a successful installation.

Oracle Database Versions

CARIS HPD Versions 1 and 2 were designed for operation with the Oracle
database version 9.2.0.4 Enterprise Edition, which includes Oracle 9i
Spatial.
CARIS HPD Version 2.3 is certified to work with Oracle version 9.2.0.4,
9.2.0.5, or 9.2.0.6. All of these include Oracle 9i Spatial.

Operating System Versions

CARIS HPD operates with the Oracle database software. As such, a CARIS
HPD database can be created in an Oracle database installed on any
operating system that is supported by the Oracle. This includes the
following:
• UNIX operating systems, e.g., Sun Solaris, DEC
• Linux
• Windows operating systems, e.g., Windows NT4, Windows 2000
and Windows XP
In cases where the Oracle is installed on a non-Windows server, a CARIS
HPD database can be installed, created or upgraded only from a Windows
operating system computer with network access to the server.
Client computers which run the CARIS HPD client applications must be
Windows-based. Prior to CARIS HPD 2.3, this includes Windows NT4,
2000 and XP. With HPD 2.3, the Windows NT4 operating system is no
longer supported; others, e.g.,
Windows 2000 and XP, remain valid.

CARIS HPD Installation Guide 1-3

Installation: IMPORTANT: Read Before Installing HPD

About The NLS_NUMERIC_CHARACTERS

Parameter
HPD requires the Oracle NLS_NUMERIC_CHARACTERS parameter to
be set to ".,", where the decimal symbol is the "." and the integer grouping
symbol is the ",".
To find out if the ORACLE settings are correct, run this query from the
DOS prompt:
SQL> select * from nls_session_parameters;
Search for the "NLS_NUMERIC_CHARACTERS" entry in the output.
If you cannot find the setting of this parameter, consult with your Oracle
Database administrator.
How to set/change the Use the following command.
value of this parameter:
SQL> alter system set NLS_NUMERIC_CHARACTERS='.,'
scope = SPFILE;
The database will need to be re-started for the changes to apply. You need
administrator privileges to do this.

Important: This change should not be done without the consent

of your database administrator as this may affect the other
applications sharing the database.

1-4 CARIS HPD Installation Guide

 Installation: Create or Upgrade Database

Create or Upgrade Database

CARIS HPD Server 2.3 programs do not have to be run on the ORACLE
server, but you must at least have the ORACLE 9 Client installed on the
computer from which the HPD Server Install program will be run.
When creating the HPD database, you must know the drive configuration
on the ORACLE server and the location (local path names on the server)
where the ORACLE data files will be created.
When creating a new database, you must know the ORACLE system login
name and password.
When running the install program for a new HPD Server installation, you
will choose from one of the following sets of procedures:
• Use the Create Database procedures if this is the first setup of
HPD or you want to create a separate database (see “CREATE A
DATABASE” ON PAGE 1-6.
• Use the Upgrade Database procedures to upgrade an existing
database (see “UPGRADE AN EXISTING HPD DATABASE” ON
PAGE 1-13

If an administrator installation is detected, the following dialog box is

displayed.

1. Select Create New Database or Upgrade Existing Database and

proceed with the relevant section below.

CARIS HPD Installation Guide 1-5

Installation: Create or Upgrade Database

Create a Database
The HPD Server Installation program creates a new HPD database (new
schema) using an installation wizard, which must be run by an
administrator.

This process requires you to have the ORACLE SYSTEM

password and Software install privileges on the computer.

For Each New Database Created:

The HPD database creation procedure creates a new ORACLE
schema. The user name specified during the installation
represents the schema owner account. The same account must
be used for any future database upgrades.

For Each New Database Created:

A new HPD database will have 400 MB of tablespace, which
covers only the database initialization and setup. If you plan to
load large amounts of data in HPD, you should ensure there is
ample tablespace available.

Step 1 1. Run the HPD Administrator Installation program.

1-6 CARIS HPD Installation Guide

 Installation: Create or Upgrade Database

2. Select the Destination Folder where the database files will be

created; it must be on a local drive.
3. Click Next.
Step 2

4. Select Create New Database.

5. Click Next.
Step 3

6. Select your IHO agency code.

7. Click OK.

CARIS HPD Installation Guide 1-7

Installation: Create or Upgrade Database

Step 4

8. Type the Oracle DBA user name in the Name field. (Typically, the
value will be “system”, but may vary depending on your setup.)
“Connectstring” (as shown in the ConnectTo field in the figure above) is a
term often found in ORACLE database documentation and refers to the
name of the database. This is the same value in the tnsnames.ora file for a
specific database.
• If the database is installed on this machine, type the database
name.
• If the database is installed on a computer on the network, the
connect string may look like databasename.host.
9. Type the name of the ORACLE database to be used in the
ConnectTo field.

Hint: Use the same “connectstring” to start an SQLPLUS

session. It is always a good idea to test connecting to your
database via SQLPLUS, as the ORACLE database
administrator, before running the HPD Admin Installation utility.

10. Click Next.

1-8 CARIS HPD Installation Guide

 Installation: Create or Upgrade Database

Step 5

This is where the schema and password are specified. The Name is the
name of the new ORACLE schema, and it will be the name of the HPD
schema owner.
By default, the HPD schema owner has HPD administrator rights. Use this
account to create new HPD users and to administer the HPD database.
11. Type the new HPD schema owner in the Name field.
12. Type the Password for the new HPD schema owner.

Use this account for any future database upgrades.

13. Click Next.

CARIS HPD Installation Guide 1-9

Installation: Create or Upgrade Database

Step 6

In this dialog box, you set up ORACLE storage information.

TableSpace refers to the name of the new ORACLE tablespace that will be
created. This tablespace stores all HPD data.
The DataFile specifies where the ORACLE data files will be stored. When
creating a database from a remote computer, the path must reflect the drive
and folder names as they exist on the ORACLE server.
14. Type the TableSpace name.
15. Type the DataFile name. (The path name must be included for a
Windows server. For UNIX servers, you must use a Windows-style
directory/data file format.).
16. Click Next.

1-10 CARIS HPD Installation Guide

 Installation: Create or Upgrade Database

Step 7

17. Review the parameters.

18. If the parameters are satisfactory, click Next; otherwise, go Back
and change any incorrect values.
Step 8 The next step asks if you want to create the database.

If you answer YES, a command window is displayed. The database creation

scripts are run from this window. The entire procedure is automatic.

Ensure you use the correct password: that is, the ORACLE
system password.

The database creation scripts go through several iterations.

The command window displays some ORACLE messages
during the database installation. This is normal; do not
attempt to stop the installation. When the installation script
is complete, a list of the errors found (if any) is displayed. The
complete report of the database creation can be found in the
file:
\CARIS\HPD\Server\2.3\NewDatabase\new_db.txt

CARIS HPD Installation Guide 1-11

Installation: Create or Upgrade Database

If you select NO, the Server directory structure and scripts are installed on
your computer, but the database is not created. To create the database you
must relaunch the Server Install and select Launch Current Database
Scripts in the first dialog box.

The following dialog boxes are the same as in a regular Server installation.
After the database has been created (or upgraded), the installation program
must be run to install the HPD client applications and support files in the
..\CARIS\HPD\Server\n.n1 folder. See “INSTALLING HPD CLIENT
APPLICATIONS” ON PAGE 1-19 for details.

If you run the HPD Server Install program on a computer that

will also hold the HPD software, you must also run the client
installation program on the same machine. The Server Install
program creates only the database, the installation programs
install the client applications.

1. Folder name used here is the default folder specified by the installation
program where x.x represents the current software version number.

1-12 CARIS HPD Installation Guide

 Installation: Create or Upgrade Database

Upgrade an Existing HPD Database

If you have an existing CARIS HPD database and want to upgrade it to
work with Version 2.3, you must upgrade from a CARIS HPD 2.2 Release
4 database. CARIS HPD Version 2.3 programs cannot operate on an older
database versions until it has been upgraded.
For a database upgrade, the installation program asks you for the schema
information, upgrades the scripts and executables and proceeds with the
database upgrade. The upgrade is necessary to allow for the various code
improvements and table optimization that occurred since the last upgrade.

Use the HPD schema owner account and database schema

name for the HPD database schema to be upgraded. You must
use the HPD schema owner account to do this—not the Oracle
administrator account.

Step 1 1. Run the HPD Server program.

1. Select the Destination Folder where the database creation files

will be stored; it must be on a local drive.
2. Click Next.

CARIS HPD Installation Guide 1-13

Installation: Create or Upgrade Database

Step 2

3. Select Upgrade Existing Database.

4. Click Next.
Step 3 You are prompted to back up your database before proceeding.

5. Click Next when you are ready to continue.

1-14 CARIS HPD Installation Guide

 Installation: Create or Upgrade Database

Step 4

6. Type the Name and ConnectTo values (use the same values as
when you created the database (see Step 8 on page 1-8); for
example, databasename or databasename.host.
7. Click Next.
Step 5

8. Review the parameters.

9. If the parameters are satisfactory, click Next; otherwise, go Back
and change any incorrect values.
Upon clicking Next, a command window is displayed prompting you for a
password; this is the HPD Schema Owner account.

CARIS HPD Installation Guide 1-15

Installation: Create or Upgrade Database

10. When prompted, type the password for your HPD Schema Owner
account.

The database upgrade scripts go through several iterations.

The command window displays some ORACLE warnings or
error messages during the first stages of the database
installation. This is normal; do not attempt to stop the
installation. Those messages should not appear when the
database creation is complete and the installation will perform
extensive checks on the database. When the installation script
is complete, a list of the errors found (if any) is displayed.

If you run the HPD Server program on a computer that will also
hold the HPD software, you must also run the client installation
program on the same machine. The Server Install program
creates only the database, the Client Installation program
installs the HPD software.

Upgrade the HPD User Run the restore_all_synonyms.sql script for all existing HPD
Accounts Version 2.3 non-schema owner accounts. This ensures that all the non-
schema owner accounts can continue to be used in HPD 2.3, and have
access to all the same database tables as the schema owner account. Use the
following steps to do this:
11. Start a command prompt window.
12. Change to the CARIS\HPD\Server\2.3\
AdminTools folder.
13. Start SQLPLUS and log in as the first HPD non-schema owner
account; for example, at the SQL> prompt, type:
sqlplus HPD_user_account/password@database.host
14. Type the following at the SQL> prompt:
@restore_all_synonyms.sql HPD_schema_owner
15. When the script is finished, stop the SQL session by typing:
quit
16. Repeat the above steps for any other HPD non-schema owner
user accounts
17. Close the command prompt window by typing
exit

1-16 CARIS HPD Installation Guide

 Installation: Create or Upgrade Database

Check the Upgrade 18. After completing the HPD database upgrade, review the following
files to ensure that the upgrade was successful:
• CARIS\HPD\Server\2.3\NewDatabase\
InstallationData.log: this file summarizes all installations and
upgrades performed on the database, which accounts were
used, the schema name, dates, and so on.
• CARIS\HPD\Server\2.3\upgrade\
Upgrade.txt: this stores the messages reported during the
upgrade procedure; the final part indicates whether there were
any errors.
These files can be sent to CARIS customer services for review if
there are any questions about the upgrade.

Repeating the Upgrade Process

If an HPD database has already been upgraded, it is not possible to run the
upgrade process again.
The upgrade process records that the current version of the database is
Version 2.3—this value is checked by any HPD upgrade program. (If you
do run the upgrade program again, the upgrade process will try to upgrade,
and then terminate without doing anything.)
If you have to run the upgrade again, for example, due to an unexpected
upgrade failure, perform the following steps:
Set version Reset the HPD installed version indicator:
1. Start a command prompt window.
2. Change to the following folder:
CARIS\HPD\Server\2.3\NewDatabase
3. Start SQLPLUS and log in as the HPD schema owner account; for
example:
sqlplus HPD_schema_account
password@database.host
4. Type the following at the SQL prompt:
UPDATE HPDVERSION SET VERSION = '2.2R4';
5. Commit the change by typing
commit;
6. When the script is finished, stop the SQL session by typing:
exit

CARIS HPD Installation Guide 1-17

Installation: Create or Upgrade Database

7. Close the command prompt window by typing

exit
Upgrade Repeat the upgrade process described above.

Contact CARIS support if further information is required.

1-18 CARIS HPD Installation Guide

 Installation: Installing HPD Client Applications

Installing HPD Client Applications

HPD client applications are packaged with a CARIS Licence

Utility, which is installed as part of the Client Install (see “USING
THE LICENCING SOFTWARE” ON PAGE 1-27 for more information).
Licencing is required to run the HPD applications.

The HPD software programs install the HPD client applications and various
support files on your computer. The program prompts you for the directory
and installs the executables and system files in the same location.
You do not need to uninstall version 2.2 before installing version 2.3. The
new version is installed in a separate folder and both versions can be used
in parallel if required. By doing this, you can become familiar with the new
version of the software, while carrying out your work with the previous
version of the software.
When you begin the installation, a warning message is displayed asking you
if you want to keep the previous installation.
If you click Yes, the previous version of the software is uninstalled and a
new version of the client software is installed. If you click No, the previous
version is retained and a new version of the software is installed on your
computer.

The following procedures show the installation procedure for

the HPD Source Editor, but all Editor applications are installed
in the same manner.

1. Run the HPD Editor Installation program.

CARIS HPD Installation Guide 1-19

Installation: Installing HPD Client Applications

The first dialog box displayed is simply a “Welcome”.

1. Click Next.
The Licence Agreement dialog box is displayed.

Read this agreement carefully. Be sure you understand and are willing to
comply with all the rules of using this software.
2. Select Yes to accept the terms of the Licence Agreement, or
select No to stop the installation procedure.

1-20 CARIS HPD Installation Guide

 Installation: Installing HPD Client Applications

The Licence Utility dialog box is displayed.

This dialog box is associated with the CARIS licencing required to use the
HPD applications (see “USING THE LICENCING SOFTWARE” ON PAGE 1-27).
3. If you are installing on a stand alone workstation, select the Local
option; if you are installing on a network, select the Network or
Server options.
4. Click Next.
The Acrobat Reader dialog box is displayed if Acrobat Reader is not
installed on the computer. Acrobat Reader is used to view documentation
that is installed with the software.

5. Select the option to install Acrobat Reader; or, select to install it

later.

CARIS HPD Installation Guide 1-21

Installation: Installing HPD Client Applications

6. Click Next.
The Destination Location dialog box is displayed.

You are prompted for the base directory where you want the HPD
applications installed. If CARIS programs were previously installed on the
computer, the default directory is directly under the base \CARIS folder.
Once the installation is finished, you may be prompted to reboot your
computer.
The base directory selected during the installation procedure will contain
the following subdirectories:
• bin stores all installed programs
• documents stores HPD-related documentation
• psldec000 stores the presentation libraries
• s57cat and s57dict store the object dictionary files
• system folder stores the basic system files and other resources for
the application.

The base directory is where the log files (.log) are saved when
the application detects a problem.

7. To change the drive or path to which HPD is installed, select the

Browse button and type or choose a new path.
8. Click Next.

1-22 CARIS HPD Installation Guide

 Installation: Installing HPD Client Applications

Use this dialog box to select a two-character code for the producing agency.
This code is included with a Feature Object ID as an identifier for the
features in the workspace.

9. Select your IHO Agency Code from the list.

10. Click Next.
The Desktop Shortcuts dialog box is displayed.

11. Select one or both options to create a desktop and/or a quick

launch shortcut.
12. Click Next.

CARIS HPD Installation Guide 1-23

Installation: Installing HPD Client Applications

The Copy Files dialog box is displayed.

13. Click Install to go to the next dialog box, or click Back to review or
change any of the previous settings.
Installation now begins and a dialog box similar to the following is
displayed indicating the progress.

As a result of the installation procedure, registry entries are made in the

following sections:
• HKEY_LOCAL_MACHINE\Software\CARIS\
<HPD application>\2.3
(Environment variables related to the various S-57 and S-52
resources and other parameters required for the proper display of
the data).

1-24 CARIS HPD Installation Guide

 Installation: Installing HPD Client Applications

• HKEY_CURRENT_USER\Software\CARIS\<HPD application>\2.3
(Windows and toolbar settings for the current user).

CARIS HPD Installation Guide 1-25

Installation: Setting Up HPD

Setting Up HPD
Before the HPD database can be used with the HPD client applications,
certain administrative procedures have to be carried out. The following
diagram presents the workflow and relevant user guides where you can find
more information.

1-26 CARIS HPD Installation Guide

 Installation: Using the Licencing Software

Using the Licencing Software

Installing the Software

To configure a computer to run CARIS HPD locally or from a network
drive you must install the CARIS licencing software.
1. Log on as the Administrator on the PC.
2. Insert the CARIS HPD CD in your CD-ROM drive.
If a previous version of the licencing software exists, remove (/r) it.
3. Use the Run item from the Start menu or File menu to execute this
command:
<CD>:CARIS\Licence Utility\Licsoft\HASPCMD\hinstall.exe /r

Now install (/i) the licencing software.

4. Use the Run item to execute this command:
<CD>:CARIS\Licence Utility\Licsoft\HASPCMD\hinstall.exe /i

Licencing can be broken into the following situations:

Windows NT Windows 2000

Any PC with CARIS HPD 1. Run hinstall /i 1. Run hinstall /i

software installed.
PC with network (red) key 1. Run hinstall /i on the PC 1. Run hinstall /i on the PC
installed 2. Run lmsetup.exe from the 2. Run lmsetup.exe from the
Licsoft\Servers\win32 directory on Licsoft\Servers\win32 directory on
the CARIS HPD CD. the CARIS HPD CD. By default,
this will be installed in a directory
called NetHASP License Manager.
To run the License Manager
3. Copy nhsrvw32.exe from the
Software, select the option “as a
NetHASP License Manager
service”. The License Manager will
directory to the windows\system
start as soon as the PC is turned on.
directory.

The executable nhsrvw32.exe

must be run every time the key
server is restarted. It is
recommended that you add
nhsrvw32.exe to the Startup menu.

CARIS HPD Installation Guide 1-27

Installation: Using the Licencing Software

Install a protection key:

5. Turn off the computer.
6. Install the protection key in the parallel port.
7. Turn the computer on again.
Your CARIS HPD software installation is complete.

You cannot access the network key if a local key exists. You
must remove the local key to use the network key.

Updating a Licence
HPD is packaged with a CARIS Licence Utility, which is installed as part
of the Client Install (see “INSTALLING HPD CLIENT APPLICATIONS” ON
PAGE 1-19). Licencing is required only for running the client executables.

You will find this item in the Windows Start > Programs > CARIS menu.
To use the HPD applications, you must have your CARIS licencing set up.
1. Copy the licence file to the ..\CARIS\CLF\ directory.
2. Select CARIS licencing Utility from the Windows Start menu.

For more information about setting up your licencing

information refer to the online help in the CARIS Licence Utility
(click the Help button).

1-28 CARIS HPD Installation Guide

 Installation: Using the Licencing Software

Installing NetHasp on a Novell Network

To connect CARIS HPD on a Windows station to a keyserver running on a
Novell server requires several operations: Add this command to a startup
file on the Novell Server:
load haspserv.nlm -ipxnosap -addr -path=%caris%\caris\bin

Each time the network is restarted, this command will create two files
called haspaddr.dat and newaddr.dat in the directory defined by the -
addrpath parameter.
For CARIS HPD licencing to work, these files must be in the directory
containing the CARIS HPD executables, and they must be current (i.e., the
ones most recently created).
If it is not possible to access the \caris\bin directory from the Novell server,
use the -addrpath parameter to define a directory that can be accessed
by the CARIS administrator, so that files can be copied to the \caris\bin
directory.
On the Client Windows box, ensure the IPX/SPX-compatible protocol is
loaded and the definition of NETHASPPROTOCOL is IPXNOSAP. This
is done using the Environment Editor.

CARIS HPD Installation Guide 1-29

Installation: Using the Licencing Software

1-30 CARIS HPD Installation Guide