3 - C H A P T E R -

C H A P T E R 3

Installing the Sun ONE Studio 4 IDE

This chapter provides step-by-step instructions on how to install your Sun ONE Studio 4, Enterprise Edition for Java software from the product CD or from files downloaded electronically from the web. It contains installation instructions for each of the supported platforms. The subdirectories installed with the IDE are described, and uninstallation instructions are also provided.

You can install Sun ONE Studio 4, Enterprise Edition for Java as a standalone product or as part of a suite of products that includes the Sun ONE Studio software. When you install using the Sun One Studio 4 update 1 product CD, you can select the product configuration during the installation. If you acquire this software as part of an electronic download, the product selection is already set for you when you start the installer.

Supporting Previous Software Releases

To upgrade your previous version of the Forte for Java IDE to Sun ONE Studio 4 software, you must do one of the following:

Determine if you want to keep your previous version of the IDE. If you do, identify a different directory in which to install the Sun ONE Studio 4 software.

If you want to use the same installation directory as the previous IDE version, you must first uninstall the previous version of the IDE prior to installing Sun ONE Studio 4 software.

Determine whether you want to keep your current IDE user settings. If you decide to use your current user settings with the new IDE version, you need to specify the location of your current user directory when prompted during the initial IDE setup. Read Chapter 4 for more information.

Creating a Shared Installation

If you want to share a Sun ONE Studio installation between multiple users, you must install the Sun ONE Studio 4 IDE into a shared directory.

On Microsoft Windows Systems

After installation of the IDE on a Microsoft Windows system, you must set your own user directory using a dialog box that appears immediately upon initial startup of the IDE from your machine. This placement occurs for both shared and unshared installations.

In a Solaris or Linux Environment

After installation of the IDE in the supported Solaris environment or Linux environment, all user settings are stored in the s1studio-user-directory created under each user's home directory. This occurs for both shared and unshared installations.

To use the IDE with a Sun Ray appliance, take the following steps:

1. Install the Sun ONE Studio IDE in a directory that is network-shared. (For example; /net/my-machine/my-shared-dir/s1studio/ee).

2. Log in to your Sun Ray appliance and start the IDE.

3. Start the J2EE RI server instance.

a. Expand the Server Registry and Installed Server nodes from the Runtime tab of the Explorer window

b. Expand the J2EE RI 1.3.1 node.

c. Righ-click RI Instance 1 and choose Start Server from the contextual menu.

Normally, the RI server instance should start properly. You might see the following error:

Error: FORTE4J_HOME environment variable does not point to your Forte For Java installation. Please set this variable to point to your Forte For Java installation.

If you see this error, modify FORTE4J_HOME environment variable in $HOME/s1studio-user-directory/j2sdkee1.3.1/bin/userconfig.sh to point to /net/my-machine/my-shared-dir/s1studio/ee.

If several users are starting and using the J2EE RI server on the same Sun Ray server, you might have to change the ports used by some of the RI services, such as the HTTP, HTTPS, EJB, and Naming and Directory services. If you are using the PointBase or Tomcat server in a multiuser environment, you might have to change the pertinent default port numbers. Refer to Appendix B, TABLE B-1 for details.

Installing the Sun ONE Studio 4 IDE on the Supported Platforms

These instructions describe the installation process for each of the supported platforms.

You can install the Sun ONE Studio 4 IDE in two ways:

Use the graphical user interface (GUI) installer, described in Installing the Sun ONE Studio 4 IDE on the Supported Platforms.

Perform a command-line installation if you do not have graphical user interface capabilities or do not want to use them. See Installing the IDE With the Command-Line Options.

Ensuring Sufficient Free Disk Space

Running the installer requires 50 megabytes of free disk space in the /tmp directory on the computer that contains the product CD-ROM. Ensure that you have this space available before starting the installation process. This requirement applies to all the supported platforms.

Finding the Product Serial Number

When you purchase the product, the serial number is listed on a card enclosed in the product package. That serial number is the number you type in the Enter Serial Number pane of the installer during installation. You can also generate a 60-day trial license serial number during the installation process.

Installation on Microsoft Windows Systems

You can install the Sun ONE Studio 4 IDE on a supported Microsoft Windows system by using the GUI installer on the product CD or by downloading an .exe file from the product download web page.

Note - You must have the J2SE, v. 1.3.1 platform or J2SE, v. 1.4.0 platform installed on your system before installing the Sun ONE Studio 4 IDE. The recommended option is the J2SE, v. 1.4.0_02 platform with the Sun ONE Studio 4 IDE. Read for instructions on installing the software.

1. Start the installation.

If you are installing the IDE from a CD, insert the Sun ONE Studio 4 update 1 product CD. The Product Selection pane appear.s

If the installer does not start, the auto run feature might be disabled. Follow these steps:

a. Click Start, click Run, and browse to the CD directory.

b. Select setup.exe and click OK.

c. Click Run (or double-click setup.exe).

Write down the serial number provided in the Sun ONE Studio 4 product package.

If you are performing a web installation and have not already done these tasks, you must:

a. Download the ffj_ee_win32_en.exe installer file from http://www.sun.com/software/sundev/jde/buy/index.html.

b. Save the file into the s1studio-download-directory.

c. Write down the serial number provided to you on the download page.

d. Double-click the ffj_ee_win32_en.exe file in the s1studio-download-directory. The Welcome screen appears.

e. Skip to Step 4.

Note - If you encounter errors at any point during the Sun ONE Studio 4 IDE installation, refer to Chapter 10 for some troubleshooting hints.

2. From the Product Selection pane, select Sun ONE Studio 4 update 1, Enterprise Edition for Java.

A brief description of this edition of the IDE appears under the list of products.

3. Click Install.

Note - During the installation process, the installation wizard displays a blue Sun ONE Studio pane with text that states "Launching and Running Installer." Other installation panes appear in the foreground. Do not close either pane. If you bring the larger blue pane to the foreground, it might hide the secondary installation pane. Keep both panes visible, with the larger blue pane behind the smaller pane.

4. When the InstallShield Wizard's welcome screen appears, click Next to continue.

The license agreement pane appears.

5. Read the license agreement carefully. To proceed, accept the terms of the license agreement, and click Next.

You must agree to the license to continue with the installation.

The installer attempts to locate a compatible Java 2 SDK v. 1.3.1 or v. 1.4.0 on your system.

6. Set the location of compatible Java 2 SDK software and click Next.

The Sun ONE Studio 4 IDE requires local or network access to either v. 1.3.1 or v. 1.4.0 of the Java 2 SDK software. Specify which installed software to use.

7. Accept the default installation folder, or click Browse to install the IDE in a different directory. Click Next to continue.

8. Specify a serial number by doing one of the following, and click Next to continue with the installation.

If you have been provided with a serial number in the Sun ONE Studio 4 product CD or as part of the electronic download process, type the number in the designated text field.

Click 60 day trial to generate a serial number that expires in 60 days. Write down the trial serial number that appears.

The trial serial number gives you access to the Update Center services once you have registered the product. Read Chapter 4 for product registration information and see Updating Modules With the Update Center for information on the Sun ONE Studio Update Center.

9. Accept the default installation folder, or click Browse to install the IDE in a different folder. Click Next to continue.

10. Select the Sun ONE Studio 4 components you want to install, and click Next.

The following components are available:

Core Platform and Modules are required (indicated by a green check mark)

PointBase Server 4.2 Restricted Edition (deselect by unchecking the box)

Java 2 Platform, Enterprise Edition (J2EE) Reference Implementation 1.3.1 (deselect by unchecking the box)

Note - The best option is to install the J2EE Reference Implementation with the IDE. This software product is provided to enable you to quickly develop a simple J2EE application, as described in Chapter 5.

11. Decide whether you want to associate .java and .nbm files with the Sun ONE Studio 4 IDE. Click Next to continue.

If you decide to associate these file types, the IDE automatically starts when you open these files.

12. Review the installation summary pane that displays the directory location of the IDE, the features you have selected, and the total size of the installation. Click Next.

13. When the installation is complete, click Finish to exit the installation wizard.

14. Review the release notes file for important information regarding the release. You can access the release notes from either of these locations:

The product CD's image\Documentation\relnote41.html file

http://forte.sun.com/ffj/documentation/index.html

15. Continue to Chapter 4 for information on setting up the Sun ONE Studio 4 IDE.

Installation in the Linux Environment

You can install the IDE in a supported Linux environment by using the Sun ONE Studio 4 update 1 product CD or by electronically downloading a .bin file from the product download web page.

1. Start the installation.

If you are installing the software from the Sun ONE Studio 4 update 1 product CD, insert the CD. The Product Selection pane appears.

a. Answer yes if you are prompted about whether you want to use Autorun to install the CD.

b. Write down the serial number provided in the Sun ONE Studio 4 product package.

c. Continue with Step 2.

If you are performing a web installation and have not already done these tasks, you must:

a. Download the ffj_ee_linux_en.bin installer file from http://www.sun.com/software/sundev/jde/buy/index.html.

b. Save the file into the s1studio-download-directory.

c. Write down the serial number provided to you on the download page.

d. Set the DISPLAY environment variable to display to your local system.

If you are installing to your local system, set the DISPLAY environment variable to :0.0. If you are using a superuser (root) account or are doing a remote installation, set your superuser session's DISPLAY environment variable to display to your local system.

For example, to set the variable from a root account running a C shell, type the following in your superuser session command prompt:

# setenv DISPLAY your-local-system:0.0

e. Set the execute permission on the ffj_ee_linux_en.bin file, and execute the file by typing the following:

$ cd s1studio-download-directory

$ chmod a+x ffj_ee_linux_en.bin

$ ffj_ee_linux_en.bin

Note - If you encounter errors at any point during the Sun ONE Studio 4 IDE installation, refer to Chapter 10 for some troubleshooting hints.

f. Skip to Step 4.

2. When the Product Selection wizard appears, select Sun ONE Studio 4 update 1, Enterprise Edition for Java.

A description of this edition of the IDE appears under the list of products.

3. Click Install.

4. When the InstallShield wizard's welcome screen appears, click Next to continue.

The license agreement pane appears.

5. Read the license agreement carefully. To proceed, accept the terms of the license agreement, and click Next.

You must agree to the license to continue with the installation.

The installer attempts to locate a compatible Java 2 SDK v. 1.3.1 or v. 1.4.0 on your system.

6. Set the location of compatible Java 2 SDK software and click Next.

The IDE requires local or network access to either v. 1.3.1 software or v. 1.4.0 of the Java 2 SDK software. Specify which installed software to use.

Note - The installation directory name cannot contain any spaces, and it must be an empty or new directory.

7. Select the Sun ONE Studio 4 components you want to install.

The following components are available:

Core Platform and Modules are required (indicated by a green check mark)

PointBase Server 4.2 Restricted Edition is required (indicated by a green check mark)

Java 2 Platform, Enterprise Edition (J2EE) Reference Implementation 1.3.1

Note - The best option is to install the J2EE Reference Implementation with the IDE. This software product is provided to enable you to develop a simple J2EE application quickly, as described in Chapter 5.

8. Confirm your installation choice in the installation summary pane, and click Next.

The installation wizard installs the Sun ONE Studio 4 components you selected.

9. Review the installation summary pane that displays the directory location of the IDE, the features you have selected, and the total size of the installation. Click Next.

10. When the installation is complete, click Finish to exit the installation wizard.

11. Review the release notes file for important information regarding the release. You can access the release notes from either of these locations:

The product CD's image\Documentation\relnote41.html file

http://forte.sun.com/ffj/documentation/index.html

12. Continue to Chapter 4 for information on setting up the Sun ONE Studio 4 IDE.

Installation in the Solaris Operating Environments

You can install the IDE in a supported Solaris operating environment by using the product CD or by downloading a .bin file from the product web page.

1. Start the installation.

If you are installing software from the Sun ONE Studio 4 update 1 product CD, insert the CD. (If you are running the Solaris 7 operating environment and you insert the product CD, a message appears stating that the product is not supported on Solaris 7 operating environment.)

a. If you are prompted to use Auto run, answer yes. The Product Selection pane appears.

If Auto run has been disabled on your system, the File Manager appears.

i. Locate the volstart installer file on the CD.

ii. Execute the volstart file.

b. Write down the serial number provided to you in the Sun ONE Studio 4 product package, if you are using the product CD.

c. Continue with Step 2.

If you are performing a web installation:

a. Download the ffj_ee_solsparc_en.bin installer file from http://www.sun.com/software/sundev/jde/buy/index.html.

b. Save the file into the s1studio-download-directory.

c. Write down the serial number provided to you on the download page.

d. Set the DISPLAY environment variable to display to your local system.

For example, to set the variable from a root account running a C shell, type the following in your superuser session command prompt:

# setenv DISPLAY your-local-system:0.0

e. Set the execute permission on the ffj_ee_solsparc_en.bin file and execute it by double-clicking the file or by typing the following:

$ cd s1studio-download-directory

$ chmod a+x ffj_ee_solsparc_en.bin

$ ffj_ee_solsparc_en.bin

Note - If you encounter errors at any point during the Sun ONE Studio 4 IDE installation, refer to Chapter 10 for some troubleshooting hints.

f. Skip to Step 4.

2. From the Product Selection pane, select Sun ONE Studio 4 update 1, Enterprise Edition for Java.

A description of this edition of the IDE appears under the list of products.

3. Click Install.

4. When the InstallShield wizard's welcome screen appears, click Next to continue.

The license agreement pane appears.

5. Read the license agreement carefully. To proceed, accept the terms of the license agreement, and click Next to continue.

You must agree to the license to continue with the installation.

The installer attempts to locate a compatible Java 2 SDK v. 1.3.1 or v. 1.4.0 on your system.

6. Set the location of compatible Java 2 SDK software, and click Next.

The IDE requires local or network access to either v. 1.3.1 or v. 1.4.0 of the Java 2 SDK software. Specify which installed Java 2 SDK software to use.

7. Specify a serial number by doing one of the following, and click Next to continue with the installation.

If you have been provided with one in the Sun ONE Studio 4 product CD or as part of the electronic download process, type it in the designated text field.

Click 60 day trial to generate a serial number that expires in 60 days. Write down the trial serial number that appears.

The trial serial number gives you access to the Update Center services once you have registered the product. Read Chapter 4 for product registration information and Updating Modules With the Update Center for information on the Sun ONE Studio Update Center.

8. Accept the default installation folder, or click Browse to install the IDE in a different directory. Click Next to continue.

Note - The installation directory name cannot contain any spaces, and it must be an empty or new directory.

9. Select the Sun ONE Studio 4 components you want to install.

The following components are available:

Core Platform and Modules (required, as indicated by a green check mark)

PointBase Server 4.2 Restricted Edition

Java 2 Platform, Enterprise Edition (J2EE) Reference Implementation 1.3.1

Solaris Developer Modules (required, as indicated by a green check mark)

a. If you select Solaris Developer Modules while performing a standalone install, such as the product web download, the FCC linking pane appears.

b. When prompted for a path to the FCC software, enter the full path to the Sun ONE Studio 7 Compiler Collection (formerly Forte Developer 7) in the provided text field.

10. Review the installation summary pane that displays the directory location of the IDE, the features you have selected, and the total size of the installation. Click Next.

11. When the installation is complete, click Finish to exit the installation wizard.

12. Review the release notes file for important information regarding the release. You can access the release notes from either of these locations:

The product CD's image\Documentation\relnote41.html file

http://forte.sun.com/ffj/documentation/index.html

13. Continue to Chapter 4 for information on setting up the Sun ONE Studio 4 IDE.

Installing the IDE With the Command-Line Options

If you prefer to install the Sun ONE Studio 4 IDE using the command line, follow these steps. You need to create a file called installer.sp and add to the file the command-line options you want to use to install the IDE.

1. If you have not already done so, download the installer file for your supported platform from http://www.sun.com/software/sundev/jde/buy/index.html or locate the file (in the image/ffj_installers_ee directory) on the Sun ONE Studio 4 update 1 product CD.

a. Save the installer file into the s1studio-download-directory.

On Microsoft Windows systems, download the ffj_ee_win32_en.exe file. In a Solaris environment, download the ffj_ee_solsparc_en.bin file. In a Linux environment, download the ffj_ee_linux_en.bin file.

b. Write down the serial number provided to you on the download page or locate the serial number in the Sun ONE Studio 4 product package, if you are using the product CD.

c. If you decide to type the installation options directly on the command line, you do not need the installer .sp file. Skip to Step 3.

2. Create an installer.sp file in the s1studio-download-directory.

The IDE installer reads the command-line options you include in the installer.sp file.

On a Microsoft Windows system, create a file called ffj_ee_win32_en.sp and place the file in the s1studio-download-directory.

For the Solaris and Linux environments, name the file ffj_ee_solsparc_en.sp and ffj_ee_linux_en.sp, respectively and place the file in the s1studio-download-directory.

3. Determine the command-line options and corresponding values you want to use, and include them in the installer.sp file.

TABLE 3-1 lists the different command-line options and their default values, if any. You can use either the long or short name for each option.


Installation Options	Description
`fortehome=`s1studio-install-directory `fh=`s1studio-install-directory	Specifies the directory into which you want the IDE installed. This is a mandatory command-line parameter for the `-silent` mode.
`jdkhome=`jdkhome-dir `jh=`jdkhome-dir	Sets the location of the valid Java 2 SDK version to use with the IDE. The installer configures the IDE to use this Java 2 SDK software. This is a mandatory command-line parameter for the `-silent` mode.
`serialnumber=`serial-number `serialnumber=trial` `sn=`serial-number `sn=`trial	Sets the serial number for the IDE. Use the serial number you received when you downloaded the Sun ONE Studio 4 IDE installer software, or the one included with the Sun ONE Studio 4 product package. You can also specify the value `trial` to generate a temporary license that will expire after 60 days. This is a mandatory command-line parameter for the `-silent` mode.
pointbaseinstall=`yes` pointbaseinstall=`no` `pi=`yes `pi=`no	Specifies whether to install the PointBase Server 4.2 Restricted Edition. The default value is `yes`.
j2eeinstall=yes j2eeinstall=no `ji=`yes `ji=`no	Specifies whether to install the J2EE Reference Implementation 1.3.1. The default value is `yes`.
fccHome=FCC_path fch=FCC_path	(Solaris only) Sets the path to the directory where the Sun ONE Studio 7 is installed. This option is valid only in a supported Solaris environment.
si=`yes` si=`no` soldevInstall=`yes` soldevInstall=`no`	(Solaris only) Specifies whether to install the Solaris Developer Modules. The default value is `yes`. This option is valid only in supported Solaris environments.
-silent	This option is specified on the command line and not in the installer`.sp` file. If not specified, the InstallShield wizard appears. If specified, any error messages will be displayed on the command window from which the installer was invoked.

For example, on a Microsoft Windows system, the ffj_ee_win32_en.sp file might have the following contents:

fh=C:\forte4j

jh=C:\j2sdk1.4.0_02

sn=trial

pi=yes

ji=yes

In a Solaris environment, the ffj_ee_solsparc_en.sp file might have the following contents:

fh=/yourserver/forte4j

jh=/usr/j2se

sn=trial

pi=yes

ji=yes

si=yes

fch=/yourserver/fcc

4. Invoke the installer from the command line.

For example, on a Microsoft Windows system, type the following in a command prompt window:

C:\>cd s1studio-download-directory

C:\s1studio-download-directory> ffj_ee_win32_en.exe -silent

For example, in a Solaris environment, type the following in a terminal window:

$ cd s1studio-download-directory

$ ffj_ee_solsparc_en.bin -silent

The installer uses the options you have specified in the installer.sp file for your system and displays the following in the command prompt window:

InstallShield Wizard

Initializing InstallShield Wizard...

Searching for Java(tm) Virtual Machine...

.........

Running InstallShield Wizard...

If you chose to use the ffj_ee_en.jar file, type your installation options when you execute the ffj_ee_en.jar file.

For example, on a Microsoft Windows system, type the following in a command prompt window:

C:\> java -Dfh=C:\forte4j -Djh=C:\j2sdk1.4.0_02 -Dpi=yes -jar ffj_ee_en.jar

Similarly, in a Solaris or Linux environment, type the following in a command prompt window, for example:

$ java -Dfh=/yourserver/forte4j -Djh=/usr/j2se -Dpi=yes -jar ffj_ee_en.jar

Any error messages are displayed in the command prompt or terminal window.

Note - If you encounter errors at any point during the Sun ONE Studio 4 IDE installation, refer to Chapter 10 for some troubleshooting hints.

5. Continue to Chapter 4 for information on setting up the Sun ONE Studio 4 IDE.

Finding Installation Subdirectories

After you have installed the Sun ONE Studio 4 IDE, the subdirectories listed in TABLE 3-2 can be found under s1studio-install-directory, your Sun ONE Studio 4 installation directory.


Subdirectory Name	Description
`LICENSE.html`	Contains the Sun Microsystems, Inc., binary code license agreement.
`/_uninst`	Contains the files used to uninstall the IDE.
`/beans`	Contains JavaBeans components installed in the IDE.
`/bin`	Includes the Sun ONE Studio 4 startup scripts (as well as the `ide.cfg` file in Microsoft Windows installations). (Solaris only) Also contains launch points for the standalone applications delivered with the Solaris tools, including `xemacs`, `gvim`, `xdesigner`, and `forte_fcc`.
`/docs`	Contains the Sun ONE Studio 4 help files and other miscellaneous documentation.
`/emacs`	(Solaris only) Contains emacs files.
`/examples`	Contains source files for examples that illustrate several key features of the Sun ONE Studio 4, Enterprise Edition for Java.
`/j2sdkee1.3.1`	Contains the J2EE Reference Implementation v. 1.3.1 files, if you chose to install those files during the Sun ONE Studio 4 installation process.
`/jwsdp`	Contains files and directories specific to the Java Web Services Developer Pack.
`/lib`	Contains the JAR files that make up the IDE's core implementation and the open APIs.
`/man`	(Solaris only) Contains man pages for Solaris Developer Modules, if installed.
`/modules`	Stores Sun ONE Studio 4 modules as JAR files.
`/platform`	(Solaris only) Contains platform-specific files.
`/pointbase`	Contains four subdirectories, `client`, `databases`, `docs`, and `server`. The `client` directory contains the PointBase console, command-line utilities, and examples of a PointBase application. The `databases` directory contains a sample database. The `docs` directory contains PointBase documentation. The `server` directory contains the PointBase server.
`/sources`	Contains sources for libraries that might be redistributed with user applications.
`/system`	Includes files and directories used by the IDE for special purposes. Go to your individual ffj-user-dir`/system` directory to get the `ide.log`, which provides information useful when requesting technical support, and to view `project.basic` and `project.last` files, which contain information on Sun ONE Studio 4 projects. On a Microsoft Windows system, this ffj-user-dir`/system` directory contains the project-specific files under `project.basic_hidden` and `project.last` files.
`/tomcat401`	Contains Tomcat-specific files.
`update_tracking.xml`	Contains information used by the Update Center.

Uninstalling the Sun ONE Studio 4 IDE

An uninstaller wizard is available to assist you in the uninstallation of the Sun ONE Studio 4 IDE. Follow these steps to uninstall your copy of the Sun ONE Studio 4 IDE:

1. Start the uninstaller from the s1studio-install-directory/ee_uninst directory.

On a Microsoft Windows system, execute the uninstaller.exe file located in the s1studio-install-directory/_uninst directory or use the Add/Remove Program utility in the Control Panel.

In a supported Solaris or Linux environment, ensure that your DISPLAY environment variable is defined correctly, and then type:

$ java -jar uninstall.jar

The uninstaller's Welcome screen appears.

2. Click Next from the Welcome screen.

A list of Sun ONE Studio 4 components is displayed.

3. Select the components you want to uninstall and click Next.

4. Click Next to confirm the components to be uninstalled.

The uninstaller wizard proceeds with the uninstallation of the IDE.

5. Click Finish to close the uninstaller wizard.