インストーラーのプロパティ

概要

インストーラーのプロパティは、Yellowfinインストーラーをカスタマイズするうえで重要です。インストーラーにさまざまな変更を加えるために、さまざまなプロパティが使用されます。たとえば以下のとおりです：

ユーザーオプションの初期値を指定する
インストーラーの操作性を変更する
インストーラーの動作を変更する
Yellowfinインストールの設定を変更する

インストーラーのプロパティの値は、さまざまな方法で指定できます。

セクション

インストーラーのプロパティは、次のページにグループ分けして説明しています：

インストーラーのプロパティ値の指定

インストーラーのプロパティの値は、さまざまな方法で設定できます。優先順に以下のとおりです：

インストーラーによって適宜提供されるデフォルトのオプション
インストーラーにバンドルされているカスタムプロパティファイル
サイレントインストーラーのプロパティファイル（サイレントインストールの場合のみ）
インストーラーによって提供されるコマンドライン引数
ユーザーがインストール中に入力するオプション（グラフィカルインストールおよびコマンドラインインストールの場合）

たとえば、コマンドラインで指定するプロパティ値は、カスタムプロパティファイル内の同じプロパティに設定された値よりも優先します。

サイレントインストーラーは、ユーザーインターフェースを表示しません。そのため、すべてのユーザーオプションは、プロパティファイルまたはコマンドライン引数を使用して指定する必要があります。

カスタムプロパティファイル

インストーラーをカスタマイズするメインの方法がカスタムプロパティファイルです。このファイルにインストーラーの操作性や動作を変更するプロパティを追加できます。このファイルは、custom.propertiesという名前のJavaプロパティファイルであり、インストーラーアーカイブのルートに追加されます（インストーラーへのファイルの追加を参照）。

このファイルは、インストールオプションの標準的なデフォルト値の指定、インストール時に表示されるテキストの上書き、インストーラーで使用するデフォルトイメージを上書きするために使用するイメージの場所の指定、インストーラーの動作の変更、Yellowfinインストールの初期設定値の指定などに使用します。カスタムプロパティファイル内のオプションは、同じプロパティの値がインストーラーのコマンドライン引数として指定される場合に上書きされます。また、グラフィカルまたはコマンドラインインストーラーを使用するときのインストールプロセス時にユーザーオプションを上書きできます。

カスタムプロパティファイルは、行ごとに「キー=値」という形式で表記される一連のキーと値のペアです。空行は無視され、#で始まる行はコメントとして扱われます。

コマンドライン引数

インストーラープロパティは、インストーラーを実行するときのコマンドライン引数として指定できます。通常の使い方は次のとおりです：

java -jar yellowfin-yyyymmdd-full.jar [-cmd|-gui] [property ...]
java -jar yellowfin-yyyymmdd-full.jar -silent [silentpropertiesfile [property ...]]

プロパティは次のように指定します：
key=valueまたは-key=value

例：

java -jar yellowfin-yyyymmdd-full.jar option.serverport=80 option.winservice=true

サイレントインストーラーのプロパティファイル

サイレントインストーラーを使用するときは、追加のプロパティファイルを指定できます。過去の経緯から、このファイル内のプロパティの名前は標準のインストーラープロパティと異なっていますが、機能は同じです。

可能な場合は、サイレントインストーラープロパティファイルではなく、カスタムプロパティファイルを使用することをお勧めします。カスタムプロパティファイルを使用した場合と比べて、サイレントインストーラープロパティファイルを介して設定できるプロパティは、非常に限られています。

サイレントインストーラーのプロパティファイルは、インストール先コンピューターのファイルシステム上に存在する必要があります。ファイル名は、-silentスイッチの後の最初の引数にする必要があります：

java -jar yellowfin-yyyymmdd-full.jar -silent install.properties

コマンドライン引数をサイレントインストーラーに渡すときは、たとえ空のファイルであっても、サイレントインストーラーのプロパティファイルを、他のオプションよりも前に最初の引数として含める必要があります。以下は動作しません：

java -jar yellowfin-yyyymmdd-full.jar -silent option.serverport=8090

使用可能なプロパティ

サイレントインストーラープロパティファイル内のプロパティキーは、大文字と小文字を区別しません。

プロパティキー	値	`custom.properties`ファイル内で対応するキー
`JavaHome`	Yellowfinを実行するときに使用するJavaインストールパス。	`option.javahome`
`InstallPath`	Yellowfinのインストール先パス。	`option.installpath`
`InstallTutorialDatabase`	チュートリアルデータベースおよびサンプルコンテンツをインストールするかどうか	`option.pack.tutorial`
`LicenceFilePath`	Yellowfinライセンスファイルの場所	`option.licencefile`
`ServicePort`	Webサーバーポート	`option.serverport`
`InstallService`	Windowsサービスをインストールするかどうか	`option.winservice`
`DatabaseType`	Yellowfin構成データベースのデータベースタイプ	`option.db.dbtype`
`Authentication`	データベースタイプがSQL Serverのときに使用する認証タイプ	`option.db.sqlauthtype`
`LogonDomain`	データベースタイプがSQL Serverで認証タイプがWindowsのときに使用するログオンドメイン	`option.db.sqldomain`
`SQLServerNamedInstance`	データベースタイプがSQL Serverのときに使用するインスタンス名。デフォルトインスタンスを使用する場合は、このプロパティを省略します。	`option.db.sqlinstance`
`ProgressDriver`	データベースタイプがProgressのときのJDBCドライバーの場所	`option.db.progressdriver`
`CreateYellowfinDB`	Yellowfin構成データベース用に新しいデータベースを作成するかどうか	`option.db.createdb`
`CreateYellowfinDBUser`	新しいデータベースユーザーを作成するかどうか	`option.db.createuser`
`DatabaseHostname`	Yellowfin構成データベースのサーバーホスト名	`option.db.hostname`
`DatabasePort`	Yellowfin構成データベースのサーバーポート	`option.db.port`
`DatabaseName`	Yellowfin構成データベースのデータベース名	`option.db.dbname`
`DatabaseDBAUser`	データベース管理者のユーザー名	`option.db.dbausername`
`DatabaseDBAPassword`	データベース管理者のユーザーパスワード	`option.db.dbapassword`
`DatabaseUser`	Yellowfin構成データベースのデータベースユーザー名	`option.db.username`
`DatabasePassword`	Yellowfin構成データベースのデータベースユーザーパスワード	`option.db.userpassword`

例

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=