[Skip to content]
TRIEMAX Software
You are here: Home > Products > Jalopy >

## Chapter 1. Installation

Describes the steps necessary to install a Jalopy distribution.

## 1.1. System requirements

Jalopy requires a properly configured Java JDK or JRE version 1.4 or later on your system. We recommend to use a version 5.0 or later JDK.

Depending on your installation options, you need at least between 5 and 20 MB free hard drive space for the installation.

## 1.2. Prerequisites

Setup should be performed with super user priviledges because Jalopy may need to create directories below certain application folders that are usually not accessible as normal user.

If you choose to install any of the provided Plug-ins, you must close any running target application(s) prior to the installation. Otherwise setup may fail because necessary files cannot be installed or obsolete files cannot be removed!

##### Download Online Help

During installation you will be asked whether you want to download and install the online help for the preferences dialog. If you're installing on a machine without Internet access, you can download the help file separately from `"http://www.triemax.com/download/jalopy-help-1.8.jar"` and either place it along the directory where the installer sits - it will then be picked up and installed automatically by the installer. Or copy the file into the Jalopy settings directory, e.g. on a typcial Windows XP system to `"C:\Documents and Settings\John Doo\.jalopy\1.8\jalopy-help-1.8.jar"`. You can find more information about the Jalopy settings directory in Section 2.1, "Overview".

The setup wizard will install the online help always into the Jalopy settings direcory as described above. But if you're doing a manual installation because you want the software to be available for all your developers without requiring them to do any extra installation work on their client machines, you can place the file into the same directory where the binaries have been installed, e.g. if the software was installed into `"C:\Program Files\jalopy"`, the binaries can be found in `"C:\Program Files\jalopy\lib"`. Just copy the help file into this directory and it will be available to all users of the binary.

## 1.3. Wizard Installation

Jalopy comes as a compressed Jar Archive (Jar) that contains all necessary application files. The Jar is executable and provides a graphical setup wizard that lets you install the software in a few easy steps. If you're about to install Jalopy for the first time, wizard installation is highly recommended. If you install an upgrade, it is usually much simpler to perform a silent install as described in Section 1.4, "Silent Installation".

To start the setup wizard, you may type

    java -jar jalopy-setup-1.8_xxx.jar

at the command line. But with modern Java virtual machines it is usually much simpler to launch the setup by just double-clicking the downloaded Jar file from within your file manager.

After you've invoked the setup wizard, the welcome screen will appear shortly.

Figure 1.1. Setup Wizard

To proceed with the installation, click the Next button.

You can press the Cancel button at any time to abort the installation. A dialog will appear that asks for confirmation.

Figure 1.2. Cancel Setup Wizard

Press the Exit button to exit the setup process. Press Continue to close the dialog and continue with the setup.

Figure 1.3. Setup Wizard License Agreement

The license agreement will be displayed. Read it carefully!

You need to accept the license agreement before you can proceed with the installation. Select the I accept the terms in the license agreement item and press the Next button to proceed.

Figure 1.4. Setup Wizard Import Settings

In case an older Jalopy release could be found on your machine, the setup lets you choose whether the settings of the prior version should be imported during installation. Select the Yes, import my settings option to have your settings imported or No, ignore any prior settings to ignore your current settings.

Additionally, you can control whether your prior settings should be deleted or kept. Select Yes, delete any prior settings to delete your existing settings. Or choose No, keep any prior settings to leave any present settings untouched.

Please note that the settings of the Open Source version are always removed during installation. If you want to keep such settings, make a backup of the Jalopy settings directory before you start the setup routine. Detailed information about the Jalopy settings system can be found in Chapter 2, Configuration.

Figure 1.5. Setup Wizard Download Online Help

You will be asked whether you want to download the help system for the preferences dialog. It is recommended to let the installer handle help installation, but if you're installing on a machine without Internet access, you can download the help file separately from `"http://www.triemax.com/download/jalopy-help-1.8.jar"` and either place it along the directory where the installer sits - it will then be picked up and installed automatically by the installer (the Download Online Help screen does not appear in such a case).

Or copy the file into the Jalopy settings directory, e.g. on a typcial Windows XP system to `"C:\Documents and Settings\John Doo\.jalopy\1.8\jalopy-help-1.8.jar"`.

Figure 1.6. Setup Wizard Installation Features

Lets you choose the program features that setup should install. Select any of the check boxes to have a feature installed.

All Plug-in features require you to select the installation directory where the target application resides, i.e. the root directory of the application. The setup wizard ensures that the Plug-in files will be copied into the appropriate places for each target application. When you first select a feature, a file chooser pops up that lets you select the installation directory for the specific application.

Figure 1.7. Setup Wizard Choose Ant Installation Directory

Please note that if multiple check boxes are selected at once, multiple file choosers will appear one after another. Don't be confused, just look at the title of each file chooser to see what application directory is required.

Setup will validate your selection and informs you when the selected directory does not match the anticipated application root directory.

Figure 1.8. Setup Wizard Installation Directory Verification Failed

Press the Choose other button if you want to select another directory. Otherwise, if you decide to miss out the feature, you can press the Skip button to skip the selection process and return to the feature selection screen (or the next file selection dialog).

Only the Eclipse Plug-in differs here, in that it may be installed into a freely chooseable folder that will only be linked to the Eclipse installation. When you choose a folder that is not the root folder of your Eclipse installation, you will be asked, whether you want to use the folder as a link folder.

Figure 1.9. Setup Wizard Installation Eclipse Directory Verification

If the link folder can be found below the Eclipse installation directory, the wizard will automatically determine the links folder, otherwise you need to choose your Eclipse installation directory in a second step.

More information about Eclipse link files can be found on IBM's developer resources: `"http://www-106.ibm.com/developerworks/opensource/library/os-ecfeat/"`

You can change the installation directory for a feature at any time using the Choose... button.

Figure 1.10. Setup Wizard Ready Screen

After the wizard has gathered all necessary information it informs you that it is now ready to perform installation.

Press the Install button to start the installation. Please note that you cannot cancel the installation process afterwards!

If you think that you made a wrong choice, press the Back button to review your settings.

Figure 1.11. Setup Wizard Progress Screen

After pressing the Install button, installation will begin and a progress dialog will inform you about the pending installation steps.

Figure 1.12. Setup Wizard Finish Screen

The last screen hopefully notifies you about installation success.

## 1.4. Silent Installation

The executable Jar file contains built-in support for silent or unattended installation. A normal wizard install guides the user through different graphical dialog boxes and expects some input. However, a silent install does not prompt the user for input. Instead it receives the required setup data from a configuration driver file that provides the information the user would otherwise enter as responses to dialog boxes.

The setup configuration driver file uses the standard java.util.Properties format. It consists of key/value pairs representing the data entries. Performing a wizard install automatically creates (or updates) a configuration driver file in the Jalopy settings directory that reflects the information given during the last setup run.

To perform a silent install, you normally type

    java -jar jalopy-setup-1.8_xxx.jar --silent

at the command line.

The installer supports a few more options to control the setup process. These are described below.

##### Options

Table 1.1. Install Wizard command-line options

Option | Long Option | Arguments | Description | Since
--- | --- | --- | --- | ---
`-c` | `--config` | <filepath> | Specifies the absolute path to the setup configuration driver file to use for the installation, e.g. `"d:\tmp\tools\jalopy-install.ini"`. If omitted, the settings of the last installation run will be used when available. | 1.4
`-h` | `--help` |  | Displays a short help | 1.4
-l | `--log` |  | Specifies the directory where the log file should be written. When omitted, the log file is stored in the Jalopy settings directory (Section 2.1, "Overview") | 1.4
-s | `--silent` |  | Performs silent install | 1.4

##### Example configuration driver file

Below you find an annotated sample configuration driver file, that explains all available keys and the possible values.

Example 1.1. Sample configuration driver file

    #Jalopy installation data
    #Fri Dec 03 09:14:37 CET 2004

    delete.settings=false
    import.settings=false
    download.help=true

    install.ant=true
    install.ant.dir=T\:\\java\\programme\\ant1.6.2

    install.console=true
    install.console.dir=C\:\\tools\\jalopy

    install.eclipse=true
    install.eclipse.dir=T\:\\java\\programme\\eclipse_test

    install.idea=true
    install.idea.dir=T\:\\java\\programme\\idea4.5
    install.idea.3.x=true
    install.idea.3.x.dir=T\:\\java\\programme\\idea3.0

    install.jbuilder=true
    install.jbuilder.dir=T\:\\java\\programme\\jbuilder10.0

    install.jdeveloper=true
    install.jdeveloper.dir=T\:\\java\\programme\\jdeveloper9.0.5.2

    install.jedit=true
    install.jedit.dir=T\:\\java\\programme\\jedit4.2pre14

    install.netbeans=true
    install.netbeans.dir=T\:\\java\\programme\\netbeans4.0
    install.netbeans.3.4=true
    install.netbeans.3.4.dir=T\:\\java\\programme\\netbeans3.6

| Header comment that contains the last modification date of the file
| delete.settings = true|false Indicates wether the settings of a prior version should be removed. "false" to keep prior settings, "true" to remove them
| import.settings = true|false Indicates wether the settings of a prior version should be imported. "false" to ignore prior settings, "true" to import them
| install.[appKey] = true|false Indicates wether the specified application Plug-in should be installed. "false" means that the Plug-in won't be installed, "true" installs the Plug-in. The valid appKeys are ant, console, eclipse, idea, idea3.x, jbuilder, jdeveloper, jbuilder, jedit, netbeans, netbeans3.4.
| install.[appKey].dir = absolute file path Specifies the absolute path file of the root application folder. The file path is stored in platform notation.

## 1.5. Manual Installation

If you prefer to install Jalopy manually yourself, you can extract the contents of the archive with your favorite zip utility and copy the different files and/or folders to the appropriate locations.

Please note that Wizard installation is mandatory for the JDeveloper and NetBeans Plug-ins!

Unzipping will produce several files and directories, but not all files are actually needed by all users.

    ..
      com-triemax-jalopy-netbeans.xml    NetBeans module config
      JALOPY-LICENSE.txt                 Jalopy license agreement
      jalopy-1.8.jar                     core Jalopy runtime library
      jalopy-ant-1.8.jar                 Ant Plug-in
      jalopy-eclipse-1.8.jar             Eclipse Plug-in
      jalopy-idea-1.8-3.0.jar            IDEA 3.0 Plug-in
      jalopy-idea-1.8.jar                IDEA 4.x Plug-in
      jalopy-jbuilder-1.8.jar            JBuilder Plug-in
      jalopy-jdev-1.8.jar                JDeveloper Plug-in
      jalopy-jedit-1.8.jar               jEdit Plug-in
      jalopy-maven-1.8.jar               Maven Plug-in
      jalopy-netbeans-1.8.jar            NetBeans 4.0 Plug-in
      jalopy-netbeans-1.8-3.x.jar        NetBeans 3.x Plug-in
      jh.jar                             JavaHelp runtime library
      NETBEANS41.MF                      NetBeans 4.1 manifest information
      THIRD_PARTY_LICENSE.txt            license terms of the used libraries
      bin/                               contains wrapper scripts for different platforms
      com.triemax.eclipse_1.8/           contains Eclipse specific application data
      com/triemax/                       contains the setup wizard install driver
      META-INF/                          contains the setup wizard meta information

Refer to the different Plug-in chapters in Part II, "Plug-ins" for further information where the files and/or directories need to be placed.