概要
設定変更ツールは、Yellowfinデータベースの設定テーブルに新しいエントリーを書き込んだり、既存のエントリーを更新したりするオプションを提供します。このツールは通常、Yellowfin インスタンツの新規インストール時に使用されます。
このツールは、Yellowfinリポジトリデータベースに直接接続し、コマンドラインを使用して変更を行います。その為、このツールを使用する前にYellowfin インスタンスを閉じることをお勧めします。
コマンドラインで実行
設定変更ツールは、Yellosin 9.7以降に付属されています。コマンドラインでは、データベースに接続するための詳細に加えて、以下の表に記載されている設定変更の詳細が必要です。
パラメーター | 説明 | 例 | 必須 |
---|---|---|---|
jdbcdriver:<driverclass> | リポジトリデータベースの標準的なJDBCドライバクラスです。 | jdbcdriver:org.postgresql.Driver | オプション |
jdbcurl:<driverurl> | リポジトリデータベースにアクセスするための接続文字列です。 | jdbcurl:jdbc:postgresql://localhost:5432/yellowfin9703 | 必須 |
jdbcuser:<user> | リポジトリデータベースへのアクセス権を持つユーザー名です。 | jdbcuser:sysadminyfn | 必須 |
jdbcpassword:<password> | リポジトリのデータベースにアクセスできるユーザー名のPlain textのパスワードです。 | jdbcpassword:highlysecure | 必須 |
CONFIG_<code>:<config_value> | 更新される設定オプションで、好きな数だけ追加できます。BOFアイテムを更新するだけであれば、CONFIGパラメータを含める必要はありません。 | CONFIG_EXTERNALURL:http://10.10.10.39:8080 | オプション |
BOF_<code>:<bof_value> | web.xmlファイルのBOFinder設定エリアの項目を設定/上書きするために使用します。 このエリアには、データベースコネクターなどのプラグインに関する設定オプションが保存されています。このツールで行った更新は、リポジトリデータベースに保存され、web.xmlよりも優先されます。 | BOF_com.hof.interfaces.EvenCreation:com.hof.interfaces.DummyEventCreation | オプション |
以下の手順は、Linuxのコマンドラインでbashシェルを使用して書かれています。他のコマンドラインを使用している場合や、設定の構文が異なる場合は、入力を調整する必要があります(例えば、ディレクトリパスにスペースが含まれている場合は、シングルクォートで囲む必要があります)。
完了すると、更新されたCONFIGおよびBOF項目がデータベースに表示されます。以下の手順で作業を進めてください。
- コンソールから、設定するYellowfinインスタンスへディレクトリを変更します。
Yellowfinのトップレベルディレクトリから、/appserver/webapps/ROOT/に移動します。
コマンドを実行します(お使いのシェルによっては、シングルクォートマークを削除する必要がありますのでご注意ください)。必要なパラメーターを確認するため、以下のヘルプテキストがコンソールに表示されます。
Yellowfin Configuration Modification Tool ========================================== Updates configuration in Yellowfin via a command-line script. Yellowfin needs to be restarted for updated configuration items to take effect. Required Parameters: JdbcDriver:<driverclass> JDBC Driver class for Repository Database (Optional) JdbcUrl:<driverurl> JDBC Database Connection String for Repository Database JdbcUser:<user> User for connecting to Repository Database JdbcPassword:<password> Password (plain-text) for authenticating User to Repository Database CONFIG_<Code>:<config_value> Configuration Item to Update BOF_<Code>:<bof_value> Internal System Plugin Item to Update
ヘルプテキスト(またはこのwikiページの上の表)を使用して、設定変更をコマンドラインテキストとして記述します。
以下のテキストは、上の表で提供したサンプルに基づいた例を示しています。java -cp ‘WEB-INF/lib/*:WEB-INF/classes’ com.hof.standalone.ModifyConfiguration jdbcuser:sysadminyfn jdbcpassword:highlysecure jdbcurl:jdbc:postgresql://localhost:5432/yellowfin9703 CONFIG_EXTERNALURL:http://10.10.10.39:8080 BOF_com.hof.interfaces.EventCreation:com.hof.interfaces.DummyEventCreation
上記の例では、ツールはYellowfinの外部URLを10.10.10/39:8080に更新し、DummyEventCreationという新しいイベントをデータベースに追加します。すべてのパラメータが有効であれば、コンソールには以下の情報が出力されます。
Yellowfin Configuration Modification Tool========================================== Updates configuration in Yellowfin via a command-line script.Yellowfin needs to be restarted for updated configuration items to take affect. Required Parameters: JdbcDriver:<driverclass> JDBC Driver class for Repository Database (Optional) JdbcUrl:<driverurl> JDBC Database Connection String for Repository Database JdbcUser:<user> User for connecting to Repository Database JdbcPassword:<password> Password (plain-text) for authenticating User to Repository Database CONFIG_<Code>:<config_value> Configuration Item to Update BOF_<Code>:<bof_value> Internal System Plugin Item to Update Parameters: JdbcUser sysadminyfn JdbcPassword ************ JdbcUrl jdbc:postgresql://localhost:5432/yellowfin9703 Found CONFIG EXTERNALURL http://10.10.10.39:8080Found BOF COM.HOF.INTERFACES.EVENTCREATION com.hof.interfaces.DummyEventCreation Selecting Existing Values SELECT IpOrg, ConfigTypeCode, ConfigCode, ConfigData FROM Configuration WHERE IpOrg = 1 AND ( ConfigTypeCode = 'SYSTEM' AND ( ConfigCode = 'EXTERNALURL' ) ) OR ( ConfigTypeCode = 'BOFINDER' AND ( ConfigCode = 'COM.HOF.INTERFACES.EVENTCREATION' ) ) Found SYSTEM/EXTERNALURL: http://10.10.10.39:8081Found BOFINDER/COM.HOF.INTERFACES.EVENTCREATION: com.hof.interfaces.DummyEventCreation Deleting existing 2 items..Deleting SYSTEM/EXTERNALURLDeleting BOFINDER/COM.HOF.INTERFACES.EVENTCREATION Inserting 2 configuration items..Inserting SYSTEM/EXTERNALURL: http://10.10.10.39:8080Inserting BOFINDER/COM.HOF.INTERFACES.EVENTCREATION: com.hof.interfaces.DummyEventCreation
CONFIG項目とBOF項目の両方の更新がデータベースに表示されるようになりました。