Installing Novell exteNd

CHAPTER 1

Preparing to Install exteNd 5

This chapter presents an overview of the Novell exteNd 5 product suite installation program. The installation program is self-documenting, but there are some decisions you need to make before you run the install. This chapter helps you make them.

Topics include:

Latest information   For the latest information on hardware and software requirements, supported databases, and specific install issues, see the Release Notes.

 
Top of page

About the installation program

The installation program is an Install Anywhere wizard that is similar on all platforms. There are several options for installing the Novell exteNd suite:

Option

Description

Platform

Express

  • Installs all suite products and features using a default configuration

  • Autoconfigures MySQL

  • Deploys the Express Portal

Windows, Linux

Server Express

  • Installs all server components

  • Autoconfigures MySQL

  • Deploys the Express Portal

Windows, Linux

Server

  • Installs only the server components

Windows, UNIX, Linux

Tools

  • Installs only the application design tools

Windows, Linux

Custom

  • Lets you select options to install a specific configuration of products and features

  • Lets you install exteNd features to a third-party application server

Windows, UNIX, Linux, NetWare®

 
Top of page

Before you install

This section explains what you need to know and do before installing exteNd 5:

 
Top of section

Preparing your computer

If you have a previously installed version of any Novell exteNd product, uninstall it before installing this version of the Novell exteNd 5 suite.

For more information    For details, see Uninstalling exteNd 5.

 
Top of section

Making installation decisions

These are the decisions you need to make before you install Novell exteNd:

What to decide

Considerations

For information see

Which install option will you use?

Applies to: Windows, UNIX, Linux, and NetWare

Details: The different install options are customized for various typical uses

Choosing an installation option

Which install mode will you use?

Applies to: UNIX and Linux

Details: You can run the installation program in either graphical mode or console mode (on Windows and NetWare, the installation program always runs in graphical mode)

Choosing an installation mode

Which database will you use for your SilverMaster?

Applies to: Windows, UNIX, and Linux (on NetWare, the suite install uses the existing exteNd Application Server and SilverMaster installed with NetWare)

Details: The exteNd Application Server requires a SilverMaster database to maintain its own system information; you need to specify a database of a supported type (DBMS) to use as SilverMaster

Choosing a database for SilverMaster

Should you configure the exteNd Application Server to run as a service or daemon?

Applies to: Windows (on UNIX and Linux, this is done after installation; on NetWare, the exteNd Application Server automatically starts by default via autoexec.ncf)

Details: If you want the exteNd Application Server to restart automatically whenever its host machine reboots, configure it to run as a Windows service or UNIX/Linux daemon

Installing the exteNd Application Server as a Service or Daemon

 
Top of section

Choosing an installation option

These are the installation options available with exteNd 5:

Install option

What it does

Platforms

Express

This is the simplest way to get started using the exteNd suite of products. In addition to installing all of the design tools and server components (including the exteNd Application Server), it creates and configures a MySQL database for use as SilverMaster and deploys a portal project (Express Portal) that can be used as your starting point for development, testing, or learning.

For more information    See Express and Server Express Installs.

Windows, Linux

Server Express

Installs the server components of exteNd (including the exteNd Application Server), but not the designers and tools used for development. The Server Express install creates and configures a MySQL database for use as SilverMaster and deploys a portal project (Express Portal) that can be used as your starting point for development, testing, or learning.

For more information    See Express and Server Express Installs.

Windows, Linux

Server

Installs the server components of exteNd (including the exteNd Application Server), but not the designers and tools used for development. The Server install asks which type of database you will use for SilverMaster and requests specific configuration information such as port numbers and passwords. The Server install is appropriate for machines that will be hosting exteNd applications.

For more information    See Server Install.

Windows, UNIX, Linux

Tools

The Tools option installs the exteNd design tools used for application development.

For more information    See Tools Install.

Windows, Linux

Custom

The Custom option allows you to select which exteNd features are installed on your machine. You can specify your own preferences for databases, port numbers, and passwords.

Custom is also the option to choose if you want to install exteNd features to a third-party J2EE application server (such as WebLogic, WebSphere, or Tomcat) instead of using the exteNd Application Server.

For more information    See Custom Install.

All platforms

 
Top of section

Choosing an installation mode

You can choose to run the installation program in one of the following modes (depending on your platform):

Install mode

Description

Graphical mode

Graphical mode displays the installation program as a window-based wizard. It is the default mode when you run the installation program on any platform.

Graphical mode is appropriate for most users.

NOTE:   Most of the examples in this guide show the installation program running in graphical mode (except where indicated).

Console mode

Console mode displays the installation program as a series of text-based prompts on the console. It is an alternative way to run the installation program on the following platforms:

  • UNIX

  • Linux

Console mode is appropriate for more advanced users.

For more information    For details on using this mode, see Installing in console mode.

No matter which mode you use, the installation program will request the same information from you and install exteNd 5 with the same result.

 
Top of section

Choosing a database for SilverMaster

The SilverMaster is a database used by the Novell exteNd Application Server. There is one SilverMaster for each application server or cluster. The SilverMaster keeps track of all deployment databases used by the application server and also holds the application server's system tables—such as tables containing security group and user information. Applications can also be deployed to the SilverMaster.

Making a DBMS choice

When choosing a DBMS to host your SilverMaster, consider the following platform issues:

Platform

DBMS considerations for SilverMaster

Windows, Linux

The Express and Server Express install options automatically install and configure MySQL. Alternatively, you can choose any supported DBMS for SilverMaster by using other install options.

NetWare

MySQL is automatically installed and configured as SilverMaster during the NetWare installation.

UNIX

You must be using a supported DBMS product and create a database to be used as SilverMaster before running the install program.

The application server can communicate with multiple database engines at once. For example, you can install your SilverMaster database on MySQL and have all of your deployment databases on another DBMS, such as Oracle.

Preparing the database to be a SilverMaster

NOTE:   If you are using the Express or Server Express option, the install automatically creates a MySQL database. Otherwise, you will have to create a database. If you are using the Custom option on Windows or Linux, a MySQL database can be created for you.

Preparing the database involves two operations:

Creating the database   You need to create a database to use as your SilverMaster before installing the application server.

Setting up the database   The application server must be able to connect to the database you want to use as SilverMaster (as well as any other databases you want it to access). The application server acts as a database client—so it requires any database client software, ODBC driver, JDBC driver, and any configuration necessary for an application connecting to a particular database.

The steps for setting up a database differ for the different database types (Oracle, and so on).

For more information    For details on setting up your database type, see the appropriate chapter in the exteNd Application Server Database Configuration Guide.

For more information    For more information about the SilverMaster database and setting it up, see the exteNd Application Server Administrator's Guide (especially the chapter on data source configuration).

 
Top of section

Using MySQL with exteNd 5

Default port number

MySQL is installed at port number 63306 when configured by the exteNd suite installer. This is to avoid conflicts with any other MySQL server running on the same machine.

MySQL on Windows

Running the Express or Server Express option installs MySQL. If you have an existing installation of MySQL running as a service on Windows, that MySQL service will be overwritten and your existing my.ini file (in the Windows product directory) will be renamed my.ini.bak.

If you want to avoid installing MySQL during the exteNd installation, use the Custom option and deselect MySQL.

MySQL on Linux

When installing MySQL on Linux, the exteNd installation program does not set up a MySQL daemon. It's recommended that you set up a daemon yourself to automatically restart MySQL whenever your system reboots. Otherwise, you can start MySQL manually by executing the script StartMySQL.sh in the Novell exteNd mysql directory.

When you install as root user on Linux, the installation program edits the /etc/password and /etc/group files with entries required to start MySQL.

MySQL on NetWare

MySQL and the exteNd Application Server are installed as part of the NetWare installation program. The exteNd 5 suite does not reinstall either the MySQL SilverMaster or the application server during the suite install.

 
Top of page

Starting the install

When you're ready to install exteNd 5, read this section to learn about starting the exteNd installation program on your platform. You can get the installation program from the exteNd product CD or by downloading one of the following files from the Novell Web site:

Platform

File to download

Windows

Novell_exteNd5nn_windows.zip

Solaris

Novell_exteNd5nn_solaris.tar

Linux

Novell_exteNd5nn_linux.tar

NetWare

Novell_exteNd5nn_netware.zip

After you download one of these archives, extract its contents to your file system. Then you can start the install:

Platform

How to start the exteNd install

Windows

  1. Find the file xtndInst.exe on the exteNd product CD or on your file system.

  2. Run this executable file.

Solaris

  1. Find the file xtndInst_sol.bin on the exteNd product CD or on your file system.

  2. Type:

      sh xtndInst_sol.bin
    

Linux

  1. Find the file xtndInst_lnx.bin on the exteNd product CD or on your file system.

  2. Type:

      sh xtndInst_lnx.bin
    

NetWare

  1. Find the file install.NCF (and accompanying archive xtndInst.jar) on the exteNd product CD or on your file system.

  2. Run this NCF file.

NOTE:   You may need to edit install.NCF before running it from your file system. Make sure the java command line in install.NCF specifies the correct path for the xtndInst.jar file. For example:

  java -cp sys:\xtndInst.jar install

Alternatively, you can execute this java command line directly (instead of using the install.NCF file).

 
Top of page

What gets installed

This section lists what gets installed or started during the installation:

If you uninstall manually, you need to make sure these are deleted or stopped.

 
Top of section

Files

The installation program installs into the directory of your choice. The default depends on your platform:

Platform

Default install directory

Windows

C:\Program Files\Novell\exteNd5

UNIX, Linux

/opt/novell/exteNd5

NetWare

SYS:\exteNd

If you are doing a manual uninstall, there are some things you may want to preserve:

 
Top of section

Services

In Windows, the installation program creates services as needed for the features you've chosen. These services may include:

Category

Service

Registry keys

Application server

Novell exteNd Application Server

My Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\exteNdAppServernn

Novell exteNd Application Server Cache Manager

My Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\exteNdCachemgrnn

Novell exteNd Application Server Dispatcher

My Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\exteNdDispatchernn

Novell exteNd Application Server Load Manager

My Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\exteNdLoadmgrnn

exteNd Director

exteNd Director Cache Coordinator

My Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\CacheCoordinator

exteNd Director DRE

My Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\DirectorDRE

MySQL server

mysql

My Computer\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\MySQL

 
Top of section

Environment variables

In Windows, the following are defined as system variables. In UNIX/Linux, they are defined in the .profile file.

AGCLASSPATH   If you installed MySQL as part of the exteNd install, the MySQL driver is added to the AGCLASSPATH environment variable. For example:

  C:\Program Files\Novell\exteNd5\MySQL\jdbc\mysql-connector-java-3.0.10-stable-bin.jar

In UNIX/Linux, AGCLASSPATH is defined in the Novell exteNd AppServer/.agprofile file.

Path modifications   In Windows, path environment variables are modified as follows:

Path

Modifications

User path

C:\Program Files\Novell\exteNd5\Director\autonomy

System path

C:\Program Files\Novell\exteNd5\AppServer\bin;C:\Program Files\Novell\exteNd5\Director\autonomy

 
Top of section

Registry keys

In Windows, the following registry keys are defined:

Application

Registry key

exteNd Application Server

My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Novell\exteNd\AppServer\n.n

exteNd DirectorTM

My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Novell\exteNd\Director\n.n

exteNd Director tools

My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Novell\exteNd\Workbench\n.n

 
Top of section

Startup items

In Windows, the exteNd install creates the following program group on the Start menu:

  Novell exteNd n.n

 
Top of page

Installing in console mode

If you've decided to run the installation program in console (text-based) mode, read this section to learn how.

For more information    For background information about the modes available when running the installation program on your platform, see Choosing an installation mode.

Procedure To run the installation program in console mode:

  1. At the command prompt, start the installation program with the -i console switch. Here's the syntax for both UNIX and Linux:

      sh installer-filename -i console
    

    For example:

    On this platform

    You type

    Solaris

    sh xtndInst_sol.bin -i console

    Linux

    sh xtndInst_lnx.bin -i console

  2. Follow the prompts as they display on the console.

    During the installation program, the following commands are available (at just about any time) to let you control its operation:

    Type this command

    If you want to

    back

    Go back to the previous prompt (to change your response or just review it)

    quit

    Cancel the install

 
Top of section

Choosing product features during a custom install

If you request a custom install while in console mode (by picking Customize... at the Choose Install Set prompt), the installation program displays the Choose Product Features prompt, including a list of the current feature selections:

  Choose Product Features
  -----------------------
  
  ENTER A COMMA_SEPARATED LIST OF NUMBERS REPRESENTING THE FEATURES YOU WOULD 
  LIKE TO SELECT, OR DESELECT. TO VIEW A FEATURE'S DESCRIPTION, ENTER 
  '?<NUMBER>'.  PRESS <RETURN> WHEN YOU ARE DONE:
  
      1- [X] exteNd Suite
      2-  |-[X] Sample Database in MySQL
      3-  |-[X] exteNd Messaging Platform
      4-  |-[X] exteNd Application Server
      5-     |-[X] Application Server
      6-     |-[X] Deployment
      7-     |-[X] SMC
      8-     |-[X] Cluster tools
      9-     |-[X] SilverJ2EEClient
     10-     |-[X] UDDI services
     11-  |-[X] Web Services SDK
     12-  |-[X] Director
     13-     |-[X] Director Designer
     14-     |-[X] Director Tools
     15-     |-[X] Autonomy DRE
     16-  |-[X] Express Portal
     17-  |-[X] Composer Server
     18-  |-[X] LDAP Utility
     19- [X] Documentation
     20- [ ] Composer Server for existing exteNd Application Server
     21- [ ] Composer Server for WebLogic
     22- [ ] Composer for WebSphere
     23- [ ] Composer Server for Tomcat
     24- [X] MySQL
  
  Please choose the Features to be installed by this installer.
     : 

This section provides some tips for completing this part of the install in console mode.

What the symbols mean   Here's a key to the Choose Product Features list:

Symbol

Meaning

[X]

The feature is selected and will be installed.

[ ]

The feature is deselected and will not be installed.

[-]

The feature is partially selected. You see this symbol for a parent item when one or more of its children are deselected. It indicates that a subset of the feature will be installed.

IMPORTANT:   If you deselect all of a parent item's children but leave the parent item partially selected, some files related to that parent item may get installed. If this is not what you want, be sure to deselect the parent item too.

How to select and deselect   The Choose Product Features prompt works by toggling any item(s) you specify:

If you

Then

Type the number of a selected or partially selected item:

  8

That item will be deselected

Type the number of a deselected item:

  22

That item will be selected

You can toggle multiple items at a time by typing the appropriate item numbers in a comma-separated list. For example:

  8,15,22

Toggling a parent item sets all of its children to the same state.

How to review your selections   After you respond to the Choose Product Features prompt, you can review your selections by typing the back command. You can then make further changes or continue on to the next install prompt.

 
Top of page

Deploying the Express Portal

Read this section to learn when you may need to deploy the Express Portal manually after installing exteNd and how to do it:

 
Top of section

About the Express Portal

To help you start working with applications right away, exteNd provides a default project called Express Portal. It's a complete portal application based on a standard exteNd Director EAR project.

The source files for the Express Portal project are installed in the Novell exteNd Projects\Express directory. The Express Portal also requires access to a database to store and manage its application data at runtime.

For more information    For further details on this project and to learn how the application works, see the chapter About the Express Portal in the exteNd Director Portal Guide.

 
Top of section

When to deploy the Express Portal yourself

The exteNd installation program automatically deploys the Express Portal if you request an Express or Server Express install (which are available when the target platform is Windows or Linux). In all other cases, you must deploy the Express Portal yourself after installation if you want to have it running on your application server.

If your target platform is UNIX or NetWare, note that Server and Custom are the only install options available, neither of which performs the Express Portal deployment. So for these server platforms, you must always deploy the Express Portal yourself if you want to use it.

 
Top of section

Installing the deployment tools

To deploy the Express Portal yourself, you'll want the exteNd designers, which include built-in tools for application generation and deployment. You can install the exteNd designers on either a Windows or Linux machine; select one of the following install options:

You can then use that Windows or Linux machine to deploy to your application server, which may be running on Windows, UNIX, Linux, or NetWare.

 
Top of section

Setting up the Express Portal database

Before deploying, you also need to set up the database required by the Express Portal. It will be used to store the Express Portal database schema and data.

Procedure To set up the Express Portal database:

  1. Create a new database or find an existing one to use; it must be a database type supported by exteNd applications (for a list, see the Release Notes).

    IMPORTANT:   To avoid conflicts, don't reuse the existing database of another deployed Express Portal.

  2. Create a JDBC connection pool on your application server for access to that database. Name the connection pool ExpressPortal.

    To create a connection pool on the Novell exteNd Application Server, use the SMC (Server Management Console). For details, see the chapter on data source configuration in the exteNd Application Server Administrator's Guide.

If you're deploying to NetWare

If you are preparing to deploy the Express Portal to the Novell exteNd Application Server on NetWare, there are some details you need to know about for proper setup of the Express Portal database.

Database type   MySQL 4.0 (which is shipped with NetWare 6.5 Support Pack 2) is not supported for the Express Portal database. But you can use MySQL 4.1 (which is installed with the exteNd 5 suite on Windows and Linux) or any other database listed in the Release Notes. To use MySQL 4.1:

  1. Do an Express install of exteNd on a Windows or Linux machine.

  2. Use MySQL-Front to create a new MySQL database on that machine. Give this database a unique name, such as ExpressPortalNW.

Connection pool   If you do create a MySQL database for the Express Portal, follow these steps to set up the JDBC connection pool for it on the NetWare server:

  1. Open the Server Management Console in the NetWare GUI by selecting Novell>exteNd Application Server>SMC.

  2. Go to Pools and click the Add button.

  3. Specify MySQL as your Database Platform and accept the pre-configured settings. Then click Next.

  4. Specify the following, then click Next.

  5. Edit the default JDBC URL as follows, then click Next.

    The resulting JDBC URL should look something like this:

      jdbc:mysql://11.222.333.44:63306/ExpressPortalNW
    
  6. When the Properties panels display, simply click Next and then Finish.

 
Top of section

Deploying the Express Portal project

The Express Portal is an exteNd Director EAR project, so you'll use the exteNd Director tools to deploy it to your application server.

Procedure To deploy the Express Portal project:

  1. Go to the Windows or Linux machine where you installed the exteNd designers.

  2. Start the exteNd Director development environment by doing one of the following:

    Platform

    What to do

    Windows

    1. Go to the list of all programs on the Windows Start menu.

    2. Select Novell exteNd n.n>Director>Director Designer.

    Windows, Linux

    1. Go to the Novell exteNd tools/bin directory.

    2. Run the executable file named xd.

  3. If the Express Portal project (Express.spf) doesn't open by default, open it yourself by selecting File>Open Project.

    You'll find Express.spf in the Novell exteNd Projects/Express directory on your local Windows or Linux machine.

  4. Select Project>Director>Configuration, then go to the Framework tab.

  5. Edit the setting Server Accessible Temp Directory to specify a temporary directory on your application server machine (needed to store some files for exteNd Director). Then click OK.

    If your application server platform is

    The temp directory setting is typically

    Windows

    C:\Program Files\Novell\exteNd5\temp

    UNIX, Linux

    /opt/novell/exteNd5/temp

    NetWare

    SYS:\exteNd\temp

    Note that the path you specify is relative to your application server machine.

  6. Select Project>Deployment Settings, then go to the Server Profiles tab and click the New button.

    When the New Server Profile dialog displays, fill it in to create a server profile that specifies your target application server. For example, these settings are for an exteNd application server running on a NetWare machine:

    instIntroProfile

    Click OK to return to the Deployment Settings dialog.

  7. Specify the User name and Password for the administrator of your application server.

  8. Go to the Deployment Info tab to specify any additional information required by the type of application server you are deploying to.

    For an exteNd application server, click the browse (...) button to select the Novell Deployment Plan to use: Express_DeplPlan.xml (in the Novell exteNd Projects/Express directory).

  9. Click OK to complete the Deployment Settings dialog.

  10. Select Project>Deploy Archive to begin deploying the Express Portal project to your specified application server.

    Watch the Output Pane for notification when the deployment has completed.

For more information    For more information, see the chapter on deploying exteNd Director applications in Developing exteNd Director Applications.

 
Top of section

Testing the deployed Express Portal

Once deployment is done, use a Web browser to see the Express Portal running on your application server. Go to this URL:

  http://serverhost:port/ExpressPortal

For an exteNd application server, the port number is typically one of the following, depending on the platform:

Application server platform

Typical port number

Windows

80

UNIX, Linux

8080

NetWare

83

 
Top of page

Uninstalling exteNd 5

If you need to remove an existing exteNd 5 installation, you can run the exteNd 5 uninstall program that's provided on your machine. To start the uninstall program, use one of the following approaches (depending on your platform).

IMPORTANT:   Before you uninstall (by using the uninstall program or manually), make sure you shut down all exteNd 5 programs, services, and daemons.

Platform

How to run the uninstall program

Windows

  1. Go to the list of all programs on the Windows Start menu.

  2. Select Novell exteNd n.n>Uninstall Novell exteNd Suite 5.

  1. Go to the Windows Control Panel and select Add or Remove Programs.

  2. Select Novell exteNd Suite 5, then click the Change/Remove button.

Windows, UNIX, Linux

  1. Go to the Novell exteNd UninstallerData/exteNdSuite directory.

  2. Run the executable file named Uninstall_ExteNd5_Suite.

Windows, UNIX, Linux, NetWare

At the command prompt, type:

  java -cp exteNd_dir/UninstallerData/exteNdSuite/uninstaller.jar uninstall

The uninstall program will run in the same mode you used when installing exteNd 5, either graphical mode or console mode.

The uninstall program won't remove files that were created or changed after exteNd 5 was installed. You can examine the remaining files to decide if there are any (as described in Files) that you want to keep. You can remove the other files and folders yourself.

Uninstalling manually   As an alternative to using the uninstall program, you can manually remove the files and other artifacts of your existing exteNd 5 installation.

For more information    See the section on What gets installed for a list of files and other artifacts to remove.

After uninstalling   No matter how you uninstall exteNd 5, make sure you reboot your machine when the uninstall is done.

 
Top of page

Contacting Technical Support

To learn about the online product support available to you, visit the Novell exteNd Web site (http://extend.novell.com/).

If you contact the Novell exteNd support staff for assistance, you will be asked to provide the following:

 
Top of section

Information about your environment

Category

Details

Product versions

Available from the About... help menu

Product type

The suite edition you are using

Operating system

The platform for your server

Database platform for SilverMaster

The DBMS you are using for your SilverMaster

Other databases

The DBMSs you are using for application deployment and application data, including versions

Database drivers

The types and versions of the database drivers you are using

Browser

The name and version number of the Web browser you are using

Java Virtual Machine version (JVM)

Displayed when you start the exteNd Application Server

Proxy servers and firewalls

Whether you are using a proxy server or firewall in your system configuration

 
Top of section

Information about your problem



Copyright © 2004-2005 Novell, Inc. All rights reserved. Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003 SilverStream Software, LLC. All rights reserved.  more ...