Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Overview

top

The Yellowfin Installer supports three modes of operation:

  1. Standard Graphical Installer
  2. Command-line Installer
  3. Silent Installer

The default behaviour is to launch the graphical installer. If no graphical environment is available, for example on a headless linux/unix server, the command-line installer will be launched instead. The installation mode can be specifically selected by adding a switch argument to the command used to run the installer:

java -jar yellowfin-yyyymmdd-full.jar -gui
java -jar yellowfin-yyyymmdd-full.jar -cmd
java -jar yellowfin-yyyymmdd-full.jar -silent

If the graphical installer is requested with -gui, but no graphical environment is available, an error message will be displayed.

There is also a Windows executable version of the installer, which only supports graphical installation mode.

Each installation mode performs the same tasks, and requires the same parameter values to be entered. However, the way they are displayed is quite different.
The general process undertaken by the installer is:

  1. Obtain values for user options
  2. Install distribution files
  3. Setup Yellowfin database
  4. Perform post-installation tasks

The installer provides a high level of customisation. Installer properties may be set which can be used to customise the text and images displayed during the installation, pre-populate user options, hide or show different options, and perform post-installation tasks to change the default behaviour of Yellowfin.

The silent installer does not display a user interface. This can be useful when bundling the Yellowfin installer as part of another installer that has its own user interface.

Adding Files to the Installer

top

The Yellowfin installer is a java archive (.jar) file. This is essentially a zip-compatible file, with some special properties. The Java Development Kit comes with a command-line tool for creating and extracting these files, called jar (jar.exe on Windows).

Customising the Yellowfin installer involves adding certain files to the installer. To do this, you should extract the contents of the installer, add the files in the correct location in the installer's file structure, and then re-create the jar archive.

To extract the contents of the installer archive:

jar xvf /path/to/yellowfin-yyyymmdd-full.jar

This will create the expanded file structure of the installer archive in the current directory. You should not modify any of the extracted files. Add any files you need to in the correct location under this directory. The custom properties file must be named custom.properties, and must be in the top-level directory. Any other files referenced as resources in the custom properties file will be specified using a path relative to this directory. After any additional files are added, re-create the archive:

jar cvmf META-INF/MANIFEST.MF /path/to/yellowfin-modified.jar

This command creates a new installer jar file, using the contents of the original file and any additional files you have added. The jar manifest file from the original installer is used.

The Windows executable installer file cannot be modified in this way. To create a modified Windows installer, first create a modified .jar installer as above, then use Launch4J to convert it to an executable file.

See http://launch4j.sourceforge.net/ for more information.

User Options

top

These options are required for installation:

  1. Whether to install the Tutorial Database and Sample Reports
  2. Whether to install the US GeoPack
  3. Location of the Yellowfin Licence File
  4. App Server Port
  5. Whether to install a Windows Service (only when the installer is run on a Windows system)
  6. Connection Parameters for the Yellowfin Database
  7. Installation Directory

In the graphical and command-line installations, these values can be entered by the user. Default values may be specified in the custom properties file or on the command-line, which will be displayed in the graphical installation.

In the silent installation, there is no user input, so the values specified in the custom properties file and on the command-line are used.

Installer Properties

top

Installer properties are the key to customising the Yellowfin installer. Different properties are used to make different changes to the installer, including:

  1. Providing initial values for user options
  2. Changing the installer's look-and-feel
  3. Changing the installer's behaviour
  4. Changing the configuration of the Yellowfin installation

Values for installer properties can be provided in different ways.

See [something] for more information.



top
  • No labels