...
Table of Contents | ||
---|---|---|
|
Overview
Installer properties are the key to customising the Yellowfin installer. Different properties are used to make different changes to the installer, including:
- Providing initial values for user options
- Changing the installer’s look-and-feel
- Changing the installer’s behaviour
- Changing the configuration of the Yellowfin installation
Values for installer properties can be provided in different ways.
Sections
The Installer Properties are grouped into the following pages:
Providing Values for Installer Properties
Values for installer properties can be set in different ways. In order of precedence, these are:
- Default options provided by the installer where appropriate
- Custom properties file bundled with the installer
- Silent installer properties file (silent installation only)
- Command-line arguments provided to the installer
- Options entered by the user during the installation (graphical and command-line installation)
For example, a property value specified on the command line will override a value set for the same property in the custom properties file.
The silent installer does not display a user interface. Therefore all user options must be provided through the properties files or command-line arguments.
Custom Properties File
The custom properties file is the main way to customise the installer. You can add properties to this file that modify the way the installer looks and behaves. This file is a java properties file named custom.properties
that is added to the root of the installer archive (see Adding Files to the Installer).
This file is used to provide standard default values for installation options, override text displayed during installation, specify the location of images used to override the default images used by the installer, modify the installer behaviour and provide initial configuration values for the Yellowfin installation. Options in the custom properties file will be overridden if a value for the same property is provided as a command-line argument to the installer, and user options can be overridden during the installation process when using the graphical or command-line installer.
The custom properties file is a series of key-value pairs of the form “key=value” on separate lines. Blank lines are ignored, and a line starting with a # is treated as a comment.
Command-line Arguments
...
概要
インストーラーのプロパティは、Yellowfinインストーラーをカスタマイズするうえで重要です。インストーラーにさまざまな変更を加えるために、さまざまなプロパティが使用されます。たとえば以下のとおりです:
- ユーザーオプションの初期値を指定する
- インストーラーの操作性を変更する
- インストーラーの動作を変更する
- Yellowfinインストールの設定を変更する
インストーラーのプロパティの値は、さまざまな方法で指定できます。
セクション
インストーラーのプロパティは、次のページにグループ分けして説明しています:
インストーラーのプロパティ値の指定
インストーラーのプロパティの値は、さまざまな方法で設定できます。優先順に以下のとおりです:
- インストーラーによって適宜提供されるデフォルトのオプション
- インストーラーにバンドルされているカスタムプロパティファイル
- サイレントインストーラーのプロパティファイル(サイレントインストールの場合のみ)
- インストーラーによって提供されるコマンドライン引数
- ユーザーがインストール中に入力するオプション(グラフィカルインストールおよびコマンドラインインストールの場合)
たとえば、コマンドラインで指定するプロパティ値は、カスタムプロパティファイル内の同じプロパティに設定された値よりも優先します。
サイレントインストーラーは、ユーザーインターフェースを表示しません。そのため、すべてのユーザーオプションは、プロパティファイルまたはコマンドライン引数を使用して指定する必要があります。
カスタムプロパティファイル
インストーラーをカスタマイズするメインの方法がカスタムプロパティファイルです。このファイルにインストーラーの操作性や動作を変更するプロパティを追加できます。このファイルは、custom.properties
という名前のJavaプロパティファイルであり、インストーラーアーカイブのルートに追加されます(インストーラーへのファイルの追加を参照)。
このファイルは、インストールオプションの標準的なデフォルト値の指定、インストール時に表示されるテキストの上書き、インストーラーで使用するデフォルトイメージを上書きするために使用するイメージの場所の指定、インストーラーの動作の変更、Yellowfinインストールの初期設定値の指定などに使用します。カスタムプロパティファイル内のオプションは、同じプロパティの値がインストーラーのコマンドライン引数として指定される場合に上書きされます。また、グラフィカルまたはコマンドラインインストーラーを使用するときのインストールプロセス時にユーザーオプションを上書きできます。
カスタムプロパティファイルは、行ごとに「キー=値」という形式で表記される一連のキーと値のペアです。空行は無視され、#で始まる行はコメントとして扱われます。
コマンドライン引数
インストーラープロパティは、インストーラーを実行するときのコマンドライン引数として指定できます。通常の使い方は次のとおりです:
Code Block | ||||
---|---|---|---|---|
| ||||
java -jar yellowfin-yyyymmdd-full.jar [-cmd|-gui] [property ...] java -jar yellowfin-yyyymmdd-full.jar -silent [silentpropertiesfile [property ...]] |
Properties are specified using:プロパティは次のように指定します:key=value
or または-key=value
For example:例:
Code Block | ||||
---|---|---|---|---|
| ||||
java -jar yellowfin-yyyymmdd-full.jar option.serverport=80 option.winservice=true |
Silent Installer Properties File
An additional properties file may be specified when using the silent installer. For historical reasons, the properties in this file have different names to the standard installer properties, but have the same functionality.
It is recommended to use the custom properties file instead of the silent installer properties file where possible. The properties available to be set through the silent installer properties file are very limited in comparison to the custom properties file.
...
サイレントインストーラーのプロパティファイル
サイレントインストーラーを使用するときは、追加のプロパティファイルを指定できます。過去の経緯から、このファイル内のプロパティの名前は標準のインストーラープロパティと異なっていますが、機能は同じです。
可能な場合は、サイレントインストーラープロパティファイルではなく、カスタムプロパティファイルを使用することをお勧めします。カスタムプロパティファイルを使用した場合と比べて、サイレントインストーラープロパティファイルを介して設定できるプロパティは、非常に限られています。
サイレントインストーラーのプロパティファイルは、インストール先コンピューターのファイルシステム上に存在する必要があります。ファイル名は、-silentスイッチの後の最初の引数にする必要があります:
Code Block | ||||
---|---|---|---|---|
| ||||
java -jar yellowfin-yyyymmdd-full.jar -silent install.properties |
When passing command-line arguments to the silent installer, you must include a silent installer properties file as the first argument before any additional options, even if it is just an empty file. The following will not work:コマンドライン引数をサイレントインストーラーに渡すときは、たとえ空のファイルであっても、サイレントインストーラーのプロパティファイルを、他のオプションよりも前に最初の引数として含める必要があります。以下は動作しません:
Code Block | ||||
---|---|---|---|---|
| ||||
java -jar yellowfin-yyyymmdd-full.jar -silent option.serverport=8090 |
Available Properties
Property keys in the silent installer properties file are not case sensitive.
...
Property Key
...
Value
...
使用可能なプロパティ
サイレントインストーラープロパティファイル内のプロパティキーは、大文字と小文字を区別しません。
プロパティキー | 値 |
|
---|---|---|
| The java installation path to use when running Yellowfin.Yellowfinを実行するときに使用するJavaインストールパス。 |
|
| The path to install Yellowfin intoYellowfinのインストール先パス。 |
|
| Whether to install the tutorial database and sample contentチュートリアルデータベースおよびサンプルコンテンツをインストールするかどうか |
|
| The location of the Yellowfin licence fileYellowfinライセンスファイルの場所 |
|
| The web server portWebサーバーポート |
|
| Whether to install a Windows serviceWindowsサービスをインストールするかどうか |
|
| The database type for the Yellowfin configuration databaseYellowfin構成データベースのデータベースタイプ |
|
| authentication type to use if the database type is SQL ServerデータベースタイプがSQL Serverのときに使用する認証タイプ |
|
| logon domain to use if the database type is SQL Server, and the authentication type is WindowsデータベースタイプがSQL Serverで認証タイプがWindowsのときに使用するログオンドメイン |
|
| instance name to use if the database type is SQL Server. To use the default instance, omit this property.データベースタイプがSQL Serverのときに使用するインスタンス名。デフォルトインスタンスを使用する場合は、このプロパティを省略します。 |
|
| The location of the JDBC driver if the database type is ProgressデータベースタイプがProgressのときのJDBCドライバーの場所 |
|
| Whether to create a new database for the Yellowfin configuration databaseYellowfin構成データベース用に新しいデータベースを作成するかどうか |
|
| Whether to create a new database user新しいデータベースユーザーを作成するかどうか |
|
| The server hostname for the Yellowfin configuration databaseYellowfin構成データベースのサーバーホスト名 |
|
| The server port for the Yellowfin configuration databaseYellowfin構成データベースのサーバーポート |
|
| The database name for the Yellowfin configuration databaseYellowfin構成データベースのデータベース名 |
|
| The database admin usernameデータベース管理者のユーザー名 |
|
| The database admin user passwordデータベース管理者のユーザーパスワード |
|
| The database username for the Yellowfin configuration databaseYellowfin構成データベースのデータベースユーザー名 |
|
| The database user password for the Yellowfin configuration databaseYellowfin構成データベースのデータベースユーザーパスワード |
|
...
例
Code Block | ||||
---|---|---|---|---|
| ||||
InstallPath=/applications/yellowfin InstallTutorialDatabase=true ServicePort=8080 InstallService=false DatabaseType=MySQL CreateYellowfinDB=true CreateYellowfinDBUser=talse DatabaseHostname=localhost DatabaseName=yellowfin DatabaseDBAUser=root DatabaseDBAPassword=secret DatabaseUser=yf DatabasePassword= |
...