設定変更ツール

概要

設定変更ツールは、Yellowfinデータベースの設定テーブルに新しいエントリーを書き込んだり、既存のエントリーを更新したりするオプションを提供します。このツールは通常、Yellowfin インスタンツの新規インストール時に使用されます。

このツールは、Yellowfinリポジトリデータベースに直接接続し、コマンドラインを使用して変更を行います。その為、このツールを使用する前にYellowfin インスタンスを閉じることをお勧めします。

---

コマンドラインで実行

設定変更ツールは、Yellosin 9.7以降に付属されています。コマンドラインでは、データベースに接続するための詳細に加えて、以下の表に記載されている設定変更の詳細が必要です。

以下の手順は、Linuxのコマンドラインでbashシェルを使用して書かれています。他のコマンドラインを使用している場合や、設定の構文が異なる場合は、入力を調整する必要があります（例えば、ディレクトリパスにスペースが含まれている場合は、シングルクォートで囲む必要があります）。

完了すると、更新されたCONFIGおよびBOF項目がデータベースに表示されます。以下の手順で作業を進めてください。

1. コンソールから、設定するYellowfinインスタンスへディレクトリを変更します。

2. Yellowfinのトップレベルディレクトリから、/appserver/webapps/ROOT/に移動します。
   コマンドを実行します（お使いのシェルによっては、シングルクォートマークを削除する必要がありますのでご注意ください）。

   java -cp ‘WEB-INF/lib/*:WEB-INF/classes’ com.hof.standalone.ModifyConfiguration

3. 必要なパラメーターを確認するため、以下のヘルプテキストがコンソールに表示されます。

   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

4. ヘルプテキスト（またはこのwikiページの上の表）を使用して、設定変更をコマンドラインテキストとして記述します。
   以下のテキストは、上の表で提供したサンプルに基づいた例を示しています。

   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:8080
   Found 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:8081
   Found BOFINDER/COM.HOF.INTERFACES.EVENTCREATION: com.hof.interfaces.DummyEventCreation
    
    
   Deleting existing 2 items..
   Deleting SYSTEM/EXTERNALURL
   Deleting BOFINDER/COM.HOF.INTERFACES.EVENTCREATION
    
    
   Inserting 2 configuration items..
   Inserting SYSTEM/EXTERNALURL: http://10.10.10.39:8080
   Inserting BOFINDER/COM.HOF.INTERFACES.EVENTCREATION: com.hof.interfaces.DummyEventCreation

5. 上記の例では、ツールはYellowfinの外部URLを10.10.10/39:8080に更新し、DummyEventCreationという新しいイベントをデータベースに追加します。すべてのパラメータが有効であれば、コンソールには以下の情報が出力されます。

   CONFIG項目とBOF項目の両方の更新がデータベースに表示されるようになりました。