23 Satellite Server JSONファイルのプロパティの管理

Satellite ServerのプロパティはSatellite Serverのwcs_properties.jsonファイルにあります。Satellite Serverのwcs_properties.jsonファイルはSatellite Serverのconfigディレクトリにあります(インストール中に指定)。Satellite Serverのwcs_properties.jsonファイルのプロパティを管理するために、WebCenter SitesにはSatellite Serverのインポート/エクスポート・ユーティリティが用意されています。

次のトピックでは、インポート/エクスポート・ユーティリティを使用したSatellite Server JSONファイルのプロパティの管理の詳細と手順について説明します。

Satellite Server JSONファイルについて

WebCenter Sitesには、Satellite Serverで必要なすべてのプロパティが含まれるSatellite Serverのwcs_properties.jsonファイルが用意されています。Satellite Server JSONファイルはSatellite Serverのconfigディレクトリにあります(インストール中に指定)。Satellite Server JSONファイルのプロパティを管理するために、WebCenter SitesにはSatellite Serverのインポート/エクスポート・ユーティリティが用意されています。

Satellite Serverのインポート/エクスポート・ユーティリティにアクセスするには、COM.FutureTense.Properties.Key/ValueStoreImportExportクラスを起動することで、コマンドライン・プロンプトを実行する必要があります。手順については、「 Satellite Serverプロパティを管理するためのインポート/エクスポート・ユーティリティの使用」を参照してください。

Satellite Serverのインポート/エクスポート・ユーティリティの概要

Satellite Serverのインポート/エクスポート・ユーティリティを使用して、Satellite Serverのwcs_properties.jsonファイルのプロパティ値を更新します。

インポート/エクスポート・ユーティリティでは、ユーザーはプロパティをSatellite Serverのwcs_properties.jsonファイルからプロパティ・ファイル形式(.iniまたは.properties)でローカル・システムへ抽出することができます。必要なプロパティを更新したら、インポート・コマンドを実行して、変更をSatellite Serverのwcs_properties.jsonファイルにインポートします。WebCenter Sitesシステムが再起動されると、プロパティの変更はすべてのSatellite Serverインスタンスで更新されます。

Satellite Serverプロパティを管理するためのインポート/エクスポート・ユーティリティの使用

Satellite Serverプロパティを更新するには、COM.FutureTense.Properties.KeyValueStoreImportExportクラスを起動して、Satellite Serverプロパティのインポートおよびエクスポート・コマンドを実行します。次の手順に示すのはWindowsシステムに対するコマンドのみです。Unixシステムでコマンドを実行している場合、コマンドは同じですが、パス区切りはセミコロンではなくコロンです。

注意:

Satellite Serverのインポート/エクスポート・ユーティリティは次の機能をサポートしません。
  1. コマンド・プロンプト・ウィンドウを開きます。
  2. 次のコマンドを使用してSatellite Serverプロパティをエクスポートします。
    >java -cp "<SATELLITE_SERVER_PRODUCT_HOME>/lib/*;<SATELLITE_SERVER_PRODUCT_HOME>/lib/oracle/*;<path_to_config_folder>" -Djava.protocol.handler.pkgs="" -Dsites.config="<path_to_config_folder>" COM.FutureTense.Properties.KeyValueStoreImportExport export <path_to_properties_file>
    

    ここで、<path_to_properties_file>は、Satellite Serverプロパティをkey=valueペア形式でエクスポートする先のプロパティ・ファイル(.iniまたは.properties)の名前です。

    ユーティリティはプロパティ・ファイルを、エクスポート・コマンドで指定したディレクトリに作成します。

  3. プロパティ・ファイルに移動し、テキスト・エディタで開きます。プロパティはkey=value形式でリストされています。必要なプロパティの値を変更してから、プロパティ・ファイルを保存します。
  4. 次のコマンドを使用して、更新されたプロパティをSatellite Server JSONファイルにインポートします。
    >java -cp "<SATELLITE_SERVER_PRODUCT_HOME>/lib/*;<SATELLITE_SERVER_PRODUCT_HOME>/lib/oracle/*;<path_to_config_folder>" -Djava.protocol.handler.pkgs="" -Dsites.config="<path_to_config_folder>" COM.FutureTense.Properties.KeyValueStoreImportExport import <path_to_properties_file>

変更したプロパティはSatellite Serverのwcs_properties.jsonファイルで更新されます。

Satellite Server JSONファイルへのプロパティの追加

特定のSatellite Server機能を有効にするには、ユーザーがSatellite Serverのwcs_properties.jsonファイルにプロパティを手動で追加することが必要です。たとえば、inCacheが有効な場合、propagatecacheプロパティをwcs_properties.jsonファイルに追加して、クラスタ・ノード間でページの伝播を有効にできます。

プロパティをSatellite Serverのwcs_properties.jsonファイルに追加する手順:
  1. Satellite Server configディレクトリ(インストール中に指定)に移動し、テキスト・エディタでwcs_properties.jsonファイルを開きます。
  2. プロパティを次の形式でSatellite Server wcs_properties.jsonファイルに追加します。
    {
       "key":"<property name>",
       "value":"<property value>",
       "valid_values":[""],
       "defaultValue":"<property value>",
       "category":"Satellite",
       "subcategory":"",
       "global":true,
       "hide":false,
       "readonly":false,
       "deprecated":false,
       "description":"Description of property"
    }
  3. Satellite Serverのwcs_properties.jsonファイルを保存して閉じます。
  4. Satellite Serverを再起動して、変更を有効にします。