Versions Compared

Version Old Version 6 New Version 7
Changes made by

YUKA SAITO

YUKA SAITO

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

Table of Contents
classcontents

概要

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


  1. ユーザーオプションの初期値の指定
  2. インストーラーのルックアンドフィールの変更
  3. インストーラーの動作の変更
  4. Yellowfinインストールの構成の変更

インストーラーのプロパティの値は、様々な方法で指定することができます。

セクション

インストーラーのプロパティを、以下のページにグループ分けしました。

  1. ユーザーオプション
  2. インストーラーのルックアンドフィール
  3. インストーラーの動作
  4. Yellowfinのシステム構成
  5. 付録 - すべてのインストーラープロパティの一覧

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

インストーラーのプロパティの値は、様々な方法で設定することができます。優先順に、以下のようになります。


  1. 必要に応じて、インストーラーにより提供されるデフォルトオプション
  2. インストーラーにバンドルされているカスタムプロパティファイル
  3. サイレントインストーラーのプロパティファイル（サイレントインストールの場合のみ）
  4. インストーラーに提供されるコマンドライン引数
  5. ユーザーがインストール中に入力するオプション（グラフィック、またはコマンドラインインストールの場合）

例えば、コマンドラインで指定されたプロパティ値は、カスタムプロパティファイル内の同様のプロパティに設定された値を上書きます。

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

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


カスタムプロパティファイルは、インストーラーをカスタマイズする主要な方法です。このファイルに、インストーラーのルックアンドフィールや動作を変更するプロパティを追加することができます。こちらのファイルは、「custom.properties」という名前のJavaプロパティファイルであり、インストーラーアーカイブのルートに追加されます（インストーラーへのファイルの追加を参照してください）。


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

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

コマンドライン引数

インストーラープロパティは、インストーラー実行時のコマンドライン引数として指定できます。一般的な使用方法は、以下の通りです。


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

プロパティは、以下のように指定されます。
key=valueまたは-key=value


例：

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

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


サイレントインストーラー使用時に、追加のプロパティファイルを指定することができます。慣例的に、このファイル内のプロパティは、標準インストーラーのプロパティとは異なる名前を持ちますが、同様の機能があります。


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

サイレントインストーラーのプロパティファイルは、インストール先コンピューターのファイルシステム上に存在しなくてはいけません。また、ファイル名は、「-silent」に切り替えた後に、最初の引数を付けなくてはいけません。

Code Block
none
none
java -jar yellowfin-yyyymmdd-full.jar -silent install.properties

コマンドライン引数をサイレントインストーラーに渡す際は、たとえ空ファイルであったとしても、サイレントインストーラーのプロパティファイルを、すべての追加オプションの前に、最初の引数として含めなくてはいけません。そのため、以下は動作しません。

Code Block
none
none
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

AppMemoryインストール時にYellowfinに割り当てるメモリ容量（メガバイト単位）。設定されていない場合は、サーバRAMの75%がデフォルトになります。option.appmemory

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構成データベースのデータベース名

注意：Oracleをインストールする場合は、こちらのキーを使用してSIDを指定するか、選択したOracle接続モードに基づくサービス名を使用します。

option.db.dbname

DatabaseDBAUser

データベースの管理者ユーザー名

option.db.dbausername

DatabaseDBAPassword

データベースの管理者ユーザーパスワード

option.db.dbapassword

DatabaseUser

Yellowfin構成データベースのデータベースユーザー名

option.db.username

DatabasePassword

Yellowfin構成データベースのデータベースユーザーパスワード

option.db.userpassword

ORACLEMODE

Oracleデータベースに接続する接続方法です。オプションは、SIDまたはサービスを含みます。選択した方法の値は、DatabaseNameキーを使用して指定しなくてはいけません。

注意：サイレントインストーラーを使用してOracleデータベースをインストールする場合は、こちらのプロパティキーを指定する必要があります。以下の、Oracleの例を参照してください。

option.db.oracleconnectionmode
JDBCDriverFiles

JDBCドライバーファイルへのパスです。複数のパスを指定する場合は、カンマで区切ります。

ヒント：これを使用して、インストーラーにパッケージ化されていないデータベースドライバーのjarファイルを提供します。

option.db.jdbcdriverfiles
OracleAuthOracleがユーザーの認証に使用する方法です。値はKerberos（Kerberos認証を使用）、またはuser（ユーザー名とパスワードを使用）となります。利用できません
KerberosFilePathKerberos設定が保存されている場所の絶対ファイルパスです。利用できません

例

以下の例を考慮します。

Code Block
none
none
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=


以下は、Oracleデータベースのインストールに要求されるプロパティキーの例です。

Code Block
DatabaseType=Oracle
DatabasePort=1521
ORACLEMODE=service
DatabaseName=ORCL