Previous Contents Index Next |
iPlanet ECXpert™ Getting Started |
Chapter 1 Preinstallation Tasks
This chapter describes planning and tasks you must perform before you can install ECXpert Version 3.0. It includes installation and configuration tasks for the RDBMS which stores the ECXpert information.
The following topics are discussed in this section:
Page references indicated throughout this section, refer to the pdf form of this document.
Installation Overview on page 14
Planning Your Configuration on page 21
Preparing the System for Installation on page 27
Creating the ECXpert Administrator Account on page 27
Installing the iPlanet Web Server, Enterprise Edition on page 29
Oracle Installation/Migration on page 29
Creating the Oracle User ECX35 on page 37
Setting Up and Testing Database Connectivity on page 38Installation Overview
This section provides an overview of the tasks required before you install ECXpert.
Hardware and Software Requirements
Table shows the minimum hardware and software requirements for installing and using ECXpert in the Sun Solaris operating environment.
Table 1-1    Hardware and Software Requirements Sun Solaris 2.6 (OS version 5.6) plus the patches listed in Table 1-2.
Sun Solaris Version 2.7 (OS version 5.7) plus the patch cluster listed in Table 1-3.
Sun Solaris Version 2.8 (OS version 5.8) - Optional, no patches are required256 MB RAM (recommended) for the Sun workstation for each ECXpert machine.
JDK 1.2.2 (to live in /share/builds/component/jdk/1.2.2_05a/SunOS
iPlanet Web Server, Enterprise Edition, Version 4.1, with Service Pack 2 (NES 4.1 SP2)
iPlanet Messaging Server Version 5.0o
iPlanet Directory Server Version 4.1 Series o
Netscape Navigator 4.7
Mercator's Mercator Version 5.0
Oracle 8.1.6 Enterprise Server (and related products, notably SQLNET and Net8
Actuate Reporting System (version 3.2 or higher)Approximately 2.5 GB for installed software (500MB each for ECXpert, 1 GB for Oracle), plus disk space for data and incoming documents, calculated according to the formula:
2.5KB * (# of documents received daily) * (# of days retained)
(See "Planning Your Configuration" on page 21 for more information on this formula.)
iPlanet Web Server, Enterprise Edition, Netscape Communicator, and iPlanet Messaging Server are on separate media.
iPlanet Directory Server is included in the iPlanet Messaging Server package.
Solaris Patches Required
Depending on the version of Solaris you are using, you must apply different Solaris patches. Solaris patches are available from Sun Microsystems' SunSolve home page:
The following sections contain specific URLs where you can download the particular patches you must apply to the different versions of Solaris.
To find out what operating system patches have been applied to your system, use the following command:
If you see the following output, patches have been applied which enable the ECXpert Java user interface to function properly.
If you see the following output, it means that no patches at all have been applied:
#
showrev -p
showrev: opendir
Solaris 2.6 Patches
If you are using Solaris 2.6, iPlanet recommends you apply the following patches shown in Table 1-2: Refer to the following README file link for more information on the patch cluster that includes these patch IDs.
http://sunsolve.Sun.COM/pub-cgi/retrieve.pl?doctype=patch&doc=2.6_Recommended.README
You may instead choose to apply the latest Solaris recommended patch cluster for Solaris 2.6. The Solaris recommended patch cluster is updated every 15 days, so it will be a later version than the iPlanet-recommended patch cluster and will not have been tested with ECXpert.
Download the latest Solaris recommended 2.6 patch cluster from:
ftp://sunsolve.Sun.COM/pub/patches/2.6_Recommended.tar.Z
Refer to the following
README
file for instructions on applying this patch cluster:ftp://sunsolve.Sun.COM/pub/patches/2.6_Recommended.README
Table 1-2    Solaris Version 2.6 (OS 5.6) Patches SunOS 5.6: ssJDK1.2.1_03 fails with fatal error in ISO8859-01 Locales.
Solaris 2.7 Patches
If you are using Solaris 2.7, iPlanet recommends you apply the following patches shown in Table 1-3: Refer to the following file link for each base patch ID on the http://sunsolve.Sun.COM site (e.g., 106980, 107636, and so forth). Alternatively, you can search for the patch ID using the Search SunSolve text entry box.
Table 1-3    Solaris Version 2.7 (OS 5.7) Patches
To find out which, if any, patch cluster has been applied to your machine, use either of the following commands:
showrev
uname -a
If the iPlanet-recommended patch cluster has been applied, the
showrev
command produces output similar to the following:
If the iPlanet-recommended patch cluster has been applied, the
uname - a
command produces output similar to the following:
#
uname -a
SunOS myhost 5.6 Generic_105181-05 sun4u sparc SUNW,Ultra-1
TCP/IP Connectivity Required
To be sure you have TCP/IP networking properly installed, the following must be in effect:
a permanent IP address is assigned to your machine (not a DHCP IP address)
TCP/IP is bound to the actual network card
DNS is configured (your machine's hostname and domain names are valid DNS entries)
The iPlanet ECXpert Installer uses the domain name in
/etc/resolv.conf
, not an NIS domain name.
To verify that your system is properly configured, follow the steps below.
Open an xterm window.
Determine what your IP address is.
Determine what your hostname is.
- type the command,
# ifconfig -a
- you should see something like this:
- lo0: flags=849<UP,LOOPBACK,RUNNING,MULTICAST> mtu 8232
- inet 127.0.0.1 netmask ff000000
- hme0: flags=863<UP,BROADCAST,NOTRAILERS,RUNNING,MULTICAST> mtu 1500
- inet 192.18.112.147 netmask fffffe00 broadcast 192.18.113.255
- ether 8:0:20:d1:2c:2f
- for the example reply above, the internet address for the machine is 192.18.112.147.
Determine what your domain name is.
- type the command:
# /bin/
hostname
- the name for this machine's host is displayed.
Ping your hostname.
- type the command:
# /bin/
domainname
- the name for your machine's domain is displayed.
Installation Checklist
Be sure to perform each task in the order presented on this checklist.
Refer back to this checklist as you complete each stage of your installation.
Plan your ECXpert site and if necessary coordinate with other sites in the same domain.
Arrange a trading partnership agreement with one or more trading partners.
Make sure your system meets hardware and software requirements. See "Installation Overview" on page 14 for more information. See "Planning Your Configuration" on page 21 for important sizing and configuration scenarios.
Familiarize yourself with the ECXpert directory structure. See "Directory tree for the ECXpert system" on page 22 for more information.
Make sure you have sufficient disk space, and have filled out the information required in the Configuration Worksheet on page 46. See "Disk Space Requirements" on page 25 for more information.
If you intend to use the iPlanet Messenging Server, see What's Next? for more information. Also, iPlanet recommends you use the ECXpert Administrator userid, generally "actraadm," as the sendmail userid.
Prepare your system for installation. See "Preparing the System for Installation" on page 27 for more information.
Create the ECXpert Administrator account. See Creating the ECXpert Administrator Account for more information.
Install Oracle. Refer to the included Oracle 8.1.6 document for Oracle 8.1.6 Installation or your site installation and configuration documentation for Oracle 8.1.6 for more detailed information.
Install iPlanet Web Server, Enterprise Edition. See Installing the iPlanet Web Server, Enterprise Edition.
Install ECXpert. See "Installing ECXpert" on page 43 for more information.
Test your installation to verify database connectivity and ECxpert operation. See "Testing Your ECXpert Installation" on page 75 for more information.
Install additional software. See "What's Next?" on page 92 for more information.
Planning Your Configuration
When planning your ECXpert site, carefully consider your resource requirements, based on the type of business you expect to do.
The central functionality of ECXpert is supported by Oracle. For ECXpert 3.5, Oracle 8.1.6 has been certified for use only.
iPlanet assumes you have your own site Database Administrator to handle routine database operations such as the following:
database full backup
database incremental (or transaction log) backup
database tablespace management
- iPlanet recommends the following formula to estimate the Oracle tablespace size needed:
- 2.5KB x [number of documents received daily] x [number of days retained]
- For example, if you have 5000 documents daily and you retain them for thirty days, the calculation is:
- 2.5KB x 5000 x 30= 375,000 KB
- For the rollback segment size, estimate 1.5 - 2 times the largest tablespace.
ECXpert Directory Structure
Figure 1-1 shows the ECXpert installation directory tree.
Refer to this diagram to identify where files and executables are located.
Figure 1-1    Directory tree for the ECXpert system
Table 1-4 describes the contents of the
$NSBASE/NS-apps/ECXpert
directory.
Disk Space Requirements
Verify that you have sufficient disk space available.
Use the following command to see the available volumes and their disk usage:
#
df -k
The resulting output is similar to the following:
Make a note of the volumes you plan to use in the installation process.
The ECXpert directory structure requires that the directories be created on a local device (hard drive) or an NFS-mounted device (hard drive).
The initial installation of ECXpert creates all of the subdirectories below the installation location you specify (referred to as
$NSBASE
).After installing ECXpert, you may change the configuration to move certain directories to other device locations, for performance reasons and to provide better fault tolerance.
Remember that you need a minimum of:
500 MB for the ECXpert software.
Sufficient space on the same system as the ECXpert software to store transaction data. Calculate the space required for your anticipated transaction volume according to the formula in Planning Your Configuration.
1GB for the Oracle database installation. This does not have to be on the same system as the ECXpert software.
Firewall Considerations
ECXpert uses the following protocols during file processing:
SMTP (port 25)
FTP (port 21)
HTTP (port 80, or user-defined port #)Additionally, ECXpert uses SQL*Net/Net8 connections (or local IPC connections based on configuration) and OCI client connections to the Oracle8i database where its tables are located.
If you want to install ECXpert through a firewall, you will need to check first with the Firewall Administrator to determine if these protocols are allowed to pass through your firewall.
Preparing the System for Installation
Prepare your system for installing ECXpert by doing the following:
Creating the ECXpert Administrator Account
Installing the iPlanet Web Server, Enterprise Edition
Oracle 8.1.6 Install/Upgrade Decisions
Creating the Oracle User ECX3.5
Setting Up and Testing Database ConnectivityThe following sections of this Guide describe these tasks.
Creating the ECXpert Administrator Account
If you are upgrading an earlier installation of ECXpert, skip this section.
Create the ECXpert Administrator user and directory. (This user's home directory must be on the installation volume only if you are running the database on the same machine as ECXpert.)
If you are confused about which user you are at any time during the installation (
database_user
,actraadm
,root
), use theid
command to identify yourself before proceeding.Set up the ECXpert Administrator account. For example:
#
/usr/sbin/groupadd actra
#
/usr/sbin/useradd -d /export/home/actraadm -g actra \
-s /bin/csh actraadm -u 1120
# passwd actraadm
- Then enter
actraadm
twice as the password.
You may use any username you wish for the ECXpert administrator user; however, for simplicity, iPlanet recommends the userid
actraadm
with a group ofactra
. iPlanet recommends a user ID of 1120 for theactraadm
user and a group ID of = 500 for the
actra
group. These are the default values the Installer expects.If you choose to use an ECXpert Administrator user with a different user ID or group ID, you must enter the correct values during Installer STEP TWO (see page 56). If you do not, you will be unable to log into the ECXpert user interface.
Write down the ECXpert Administrator user's User ID and Group ID values in Configuration Worksheet items 3. User ID: and 4. Group ID:.
Enabling Sendmail
If you plan to use Sendmail, use the
touch
command and specify the useractraadm
) to make sure the mail file can be read/written to by user actraadm. For example:
#
touch /var/mail actraadm
Using the
touch
command is also indicated in Step 4 of the Installation.
Installing the iPlanet Web Server, Enterprise Edition
Install the iPlanet Web Server, Enterprise Edition and Netscape Communicator by following the instructions enclosed with the software.
After ECXpert installation, you must make changes in the iPlanet Web Server's
obj.conf
file so that the document root andcgi-bin
point to thehtml
andcgi-bin
directories of ECXpert.
Oracle Installation/Migration
iPlanet ECXpert 3.5 is certified to run with Oracle 8.1.6 Enterprise Server edition (also known as Oracle 8i). If you have an earlier installed version of Oracle, refer to the Oracle 8.1.6 Installation documentation or contact Oracle for instructions on upgrading to version 8.1.6. Once upgraded to 8.1.6, continue with the section "Creating the Oracle User ECX35 on page 37." If you do not have any version of Oracle installed, proceed to the section below, Preinstallation Tasks for Oracle 8.1.6 Enterprise Server.
Preinstallation Tasks for Oracle 8.1.6 Enterprise Server
Before you install Oracle 8.1.6, you must first:
Configure shared memory. See "Configuring Shared Memory and Semaphores" on page 30.
Create theoracle
user. See "Creating the Oracle User" on page 31.
Prepare the environment for installation. See "Preparing the Environment" on page 32.Configuring Shared Memory and Semaphores
For a new installation of Oracle 8.1.6, you must edit the
/etc/system
file to properly configure shared memory and semaphores. Following this, your machine must be rebooted. Perform the following steps:Log in as, or become, the
root
user:
Change to the
# su - root
/etc
directory
Create a backup copy of your system file:
- #
cd /etc
Carefully edit the
- #
cp system system.backup
system
file as needed to include the following lines.
Reboot your machine.
- These lines should appear at the end of the file, immediately the comments regarding "set."
- For the changes to take effect, you must reboot your machine using the following two commands:
- #
sync
# init 6
Creating the Oracle User
If you want to set up Oracle in a remote client configuration you must create an
oracle
user ID on each machine.
Log on as or become the
root
user:
Create the dba group.
- #
su - root
Create a home directory for the Oracle user. For example:
- If the machine you are using does not already have a dba group, you must create one:
#
groupadd dba
Add the
- #
mkdir
/disk1/oracle
- where
/disk1/oracle
is theoracle
user's UNIX home directory.
oracle
user. For example:
Transfer ownership of the
# useradd -g dba -d /disk1/oracle -s /bin/csh oracle
oracle
user's home directory. For example:
Change the group association of the
- #
chown oracle
/disk1/oracle
oracle
user's home directory:
Set the
- #
chgrp dba
/disk1/oracle
oracle
user's password
#
passwd oracle
New password:
password
Re-enter new password:
password
- where
password
is the new password for theoracle
user.
Preparing the Environment
Log on as or become user Oracle:
Set up the environment for the installation.
- #
su - oracle
Use the following syntax to set the environment variables:
- Set the appropriate environment variables in the Oracle user's
.profile
or.login
file before starting the Installer.
Use the information in Table 1-5 to determine how to set up each environment variable.
- For the C shell:
setenv
variable_name value
- For the Bourne shell:
set
variable_name value
export
variable_name
Refer to your Oracle documentation for additional information about these and other potentially important environment variables.
Table 1-5    Environment Variables Set to the name and monitor of the machine from which you are installing the Oracle software.
Set to include
$ORACLE_HOME/lib
and the directory containing your Motif libraries.Important: When you set up your environment prior to installing or upgrading, make sure that the
$ORACLE_HOME/lib
directory appears as the first value in the$LD_LIBRARY_PATH
environment variable. If you do not do this, you will get errors when you later use SQL*Plus.Note: The default location for Motif libraries on Solaris 2.x is
/usr/openwin/lib
or/usr/dt/lib
.Set to the directory containing the Oracle software for a given Oracle Server release. The OFA-recommended value is:
Example:
/export2/oracle8i/app/oracle/product/8i
Important: Write this value in item 9 of the Configuration Worksheet on page 46.
Set to the Oracle SID, which is the name of the Oracle Server instance.
Note: If you are installing Oracle as a remote client, set this value to the database on the server machine.
Important: Write this value in item 10 of the Configuration Worksheet on page 46.
Set to the terminal definition resource file to be used with the Installer. Refer to your Oracle documentation for a complete list of terminal definition resource files.
Set to the correct NLS_LANG character set.
The character set is named according to the following convention:
<language>_<territory>.<number>
Example: american_america.US7ASCII
Important: Enter this value in item 11 of the Configuration Worksheet on page 46.
Create an oratab file as follows:
where
$ORACLE_HOME
is the$ORACLE_HOME
of the new Oracle 8i, release 8.1.6 installation.Note: This environment variable must be properly set if you plan to use a non-US7ASCII character set.
Example:
/export2/oracle8i/app/oracle/product/8.1.6/ bin:/bin:/usr/bin:/usr/ccs/bin:$PATH
Set this to the same value as the
ORACLE_TERM
environment variable.
Installing Oracle 8.1.6
Log on as or become the
oracle
user.
Run the Oracle Universal Installer.
#
su - oracle
- Warning: Do not run the Installer as
root
user. You must be logged in as useroracle
.
- Insert your Oracle8i, release 8.1.6 CD-Rom in the CD drive
- Change to the CD installation directory:
#
cd /cdrom/oracle8i/
- To start the installer, enter the following two command:
#
./setup /
The Oracle Universal Installer will lead you through the Oracle installation process. The typical installation type option will suffice for most installations. When asked about installing the Multi-threaded Server option (MTS), accept installation using that option. Other custom installation option should be handled by an experienced Oracle DBA.
During installation, you will be prompted for some of the environment variables set according to the guidelines presented in Table 1-5. You will also be instructed to open another terminal window and log in as root to run the root.sh script.
Running the root.sh Script
Log on as or become the
root
user.
Change to the $ORACLE_HOME
#
su root
/orainst
directory:
Run the
#
cd $ORACLE_HOME/orainst
root.sh
script:
#
./root.sh
- If you run
root.sh
from a directory other thanORACLE_HOME
, you get the following message:
ORACLE_HOME does not match the home directory for oracle.
Okay to continue? [N]:
- If you indicate Yes, the
root.sh
script continues, using theORACLE_HOME
environment variable you specified.
- Depending on the products you installed, you may be prompted for user names and may be given additional instructions. Refer to your Oracle documentation for more information on these messages.
Recommended Settings for initECX.ora File
iPlanet recommends that you open (and edit, as needed) the
initECX.ora
file to verify the use of the LARGE default values generated during the Oracle Enterprise Server installation process. These default values are indicated by the parameters shown in Table .
Table 1-6    LARGE Values for Parameters in the initECX.ora File
Creating the Oracle User ECX35
Follow these steps create the Oracle user ECX35, who will own the ECXpert tables.
Log onto Solaris with your Oracle account. For example:
Launch the Oracle Server Manager utility.
login:
oracle
password:
oracle
#
svrmgrl
SVRMGR>
connect system/manager
Create userECX35
.
Setting Up and Testing Database Connectivity
Before you install ECXpert, set up and test your database to be sure that user
root
has access to the database, so that you can successfully install ECXpert. If userroot
doesn't have access to the database, you will get error messages during the ECXpert installation.Log in as user
root
.
Determine the shell that
#
su - root
root
uses.
Determine the shell that
#
echo $SHELL
- The output of this command identifies the shell that
root
uses, which determines its associated environment file:
oracle
uses.
Get into the
#
cat /etc/passwd | grep oracle
- The output of this command lists the shell at the end, as in the sample below:
oracle:x:50004:10003::/export/home/oracle:/bin/csh
- where the shell is
csh
.
oracle
shell.
- Locate the shell in the "Output" column of the table in Step 2 above, then look up the entry in the "Environment File" column for the same row.
If you are using the C shell, type the following command:
Check the environment settings.
If you are using the Korn shell or the Bourne shell, type the following command:
#
source ~oracle/
.cshrc
- #
. ~oracle/
your_environment_file
Correct environment variable definitions as necessary.
#
env
- The following sample output of this command lists the environment variables that must be set:
Refer to the Configuration Worksheet on page 46 for your
$ORACLE_HOME
(worksheet item 10).
$ORACLE_HOME=
$ORACLE_HOME from worksheet
$ORACLE_SID=ECX
$LD_LIBRARY_PATH=$ORACLE_HOME/lib:$LD_LIBRARY_PATH
$PATH=$ORACLE_HOME/bin:$ORACLE_HOME:$PATH
$DISPLAY=hostname
:0.0
- If any of the above environment variables are not properly defined:
Change to user
Enable changes in environment variable definitions.oracle
(su - oracle
).
Open the environment file that you referenced in Step 4 above in a text editor and add or modify the definitions as necessary.
Save the environment file and exit the text editor.
Check your
- If you made changes in the environment file in Step 6 above, enable those changes now by switching to another user and then switching back:
#
su - root
#
su - oracle
- Alternatively, you could restart your system and log in as
oracle
.
tnsnames.ora
file.
Connect to the database from the UNIX commandline.
- Check your
tnsnames.ora
file to make sure it contains the correct information. as follows:
SX = ECX35
(DESCRIPTION =
(ADDRESS = PROTOCOL = TCP)(Host=bobo)(Port=1521)
(CONNECT_DATA = (SID = ECX35)
Repeat the test from inside SQL*Plus:
- #
sqlplus ECX35/
ECX35@
your_connect_string
- If this test fails, skip to Step 11.
Correct any connectivity problems.
SQL>
connect ECX35/ECX35@
your_connect_string
SQL>
exit
- If the test at either Step 9 or Step 10 failed, check the
tnsnames.ora
andlistener.ora
file to validate the settings, such as hostname and SID.
- After making any necessary changes, go back to Step 9 above.
If you have successfully connected to the database using SQL*Plus, you will be able to connect during the ECXpert installation. If you cannot connect to the database using this method, you definitely will not be able to connect during the ECXpert installation.
For additional Oracle troubleshooting tips, refer to the iPlanet ECXpert Operations Reference Manual.
Copyright © 2000 Sun Microsystems, Inc.
Some preexisting portions Copyright © 2000 Netscape Communications Corp. All rights reserved.