1 JSONファイルのプロパティの管理

この章では、JSONファイルに保存されたOracle WebCenter Sitesプロパティを管理するためのプロパティ管理ツールおよびインポート/エクスポート・ユーティリティの使用について説明します。

Oracle WebCenter Sitesおよびそのアプリケーションの多くの構成タスクでは、WebCenter SitesおよびSatellite Server JSONファイル(wcs_properties.json)に指定されたプロパティの値を設定または変更することが必要です。

プロパティを管理するために、WebCenter Sitesには、プロパティ管理ツールおよびインポート/エクスポート・ユーティリティが用意されています。多くのプロパティはWebCenter SitesおよびSatellite Serverのwcs_properties.jsonファイルにありますが、zookeeperプロパティなどのその他のプロパティは個別のプロパティ・ファイルに保存されています。この概要では、wcs_properties.jsonファイル、プロパティ管理ツールおよびインポート/エクスポート・ユーティリティについて説明します。

この項の内容は次のとおりです。

1.1 WebCenter Sites JSONファイルについて

ほとんどのWebCenter SitesのプロパティはWebCenter Sitesのwcs_properties.jsonファイルにあります。WebCenter Sites JSONファイルは、WebCenter Sitesインストールの<domain_home>/wcsites/wcsites/configディレクトリにあります。

WebCenter SitesにはWebCenter Sitesのwcs_properties.jsonファイルのプロパティを管理するのに、2つの方法が用意されています。

WebCenter Sites管理インタフェースからアクセスできるプロパティ管理ツール。詳細は、「プロパティ管理ツールへのアクセス」を参照してください。
propertiesUtility.bat (Windowsの場合)およびpropertiesUtility.sh (Unixの場合)に対しコマンドライン・プロンプトを実行することでアクセスするインポート/エクスポート・ユーティリティ。手順については、「WebCenter Sitesプロパティを管理するためのインポート/エクスポート・ユーティリティの使用」を参照してください。

次のトピックでは、WebCenter Sitesのwcs_properties.jsonファイルを管理するのに使用するツールの概要について説明します。

1.1.1 プロパティ管理ツールの概要

WebCenter Sitesが実行している場合、プロパティ管理ツールを使用してWebCenter Sitesのwcs_properties.jsonファイルのプロパティの値を設定します。このファイルのプロパティの値を設定するには常にプロパティ管理ツールを使用することをお薦めします。

プロパティ管理ツールでは、プロパティ値が適切に書式化されます。具体的にはプロパティの正しい区切り文字が使用されます。また、プロパティ管理ツールは、プロパティに関する説明とデフォルト値または可能な値を示します。さらに、WebCenter Sitesのwcs_properties.jsonファイルのプロパティはカテゴリ別に編成されるので、プロパティ管理ツールでは、ユーザーがカテゴリおよびサブカテゴリでプロパティを検索することができます。

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

WebCenter Sitesが実行していない場合、インポート/エクスポート・ユーティリティを使用してWebCenter Sitesのwcs_properties.jsonファイルのプロパティを変更します。

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

1.2 WebCenter Sites JSONファイルのプロパティ値の表示

システムに構成されたすべてのプロパティとその値を表示する手順:

WebCenter Sitesにログインして、サイト名を選択し、管理インタフェースにアクセスします。
ナビゲーション・ペインで、「一般的な管理」セクションを選択してから「管理」を展開します。
「管理」ツリーで「システム・ツール」、「システム情報」の順に開き、「Sites情報」をダブルクリックします。
「Sites情報」フォームが開きます。
「Sitesプロパティ」の「使用可能」リスト・ボックスで、wcs_properties.jsonファイルを選択してから「追加」をクリックします。
「結果の表示」をクリックします。
「Sitesプロパティ」フォームが開き、wcs_properties.jsonファイルの名前が表示されます。
wcs_properties.jsonノードを開き、すべてのプロパティのリストと現在の値を表示します(図1-1を参照)。
図1-1 Sitesプロパティ

「図1-1 Sitesプロパティ」の説明

1.3 プロパティ管理ツールの使用

次のトピックでは、プロパティ管理ツールの操作手順について説明します。

1.3.1 プロパティ管理ツールへのアクセス

プロパティ管理ツールはWebCenter Sites管理インタフェースにあります。

管理者資格証明を使用してWebCenter Sitesにログインし、サイトの名前を選択してから、「管理」インタフェース・アイコンを選択します。
「管理」ツリーで、「システム・ツール」ノードを開きます。
「システム・ツール」ノードで、「プロパティ管理」をダブルクリックします。
図1-2に示すように「プロパティ管理ツール」が開きます。

図1-2 プロパティ管理ツール

「図1-2 プロパティ管理ツール」の説明

1.3.2 プロパティの設定

この項では、WebCenter Sitesおよびそのアプリケーションのプロパティの設定手順について説明します。

プロパティ管理ツールを「プロパティ管理ツールへのアクセス」に記載されているように開きます。
構成するプロパティを検索します。次のフィールドの値を入力します。
- 名前: 表示するプロパティの完全な名前または名前の一部を入力します。
- カテゴリ: (オプション)プロパティに関連するカテゴリの名前を選択します。
- サブカテゴリ: (オプション)カテゴリが「カテゴリ」フィールドから選択された場合、そのカテゴリに関連するサブカテゴリがドロップダウン・メニューに表示されます。プロパティに関連するサブカテゴリの名前を選択します。
- グローバル: 次のオプションのいずれかを選択します。
  - すべて: 指定した名前およびカテゴリのすべてのプロパティが結果に表示されます。
  - True: 「グローバル」フラグがtrueに設定されたプロパティのみが結果に表示されます。
  - False: 「グローバル」フラグがfalseに設定されたプロパティのみが結果に表示されます。
「検索」をクリックします。
検索条件に一致するプロパティがページの「プロパティ」セクションにリストされます。
変更する値を含むプロパティの名前をクリックします。
プロパティの詳細は次のように表示されます。
- カテゴリ: このプロパティがリストされるカテゴリを示します。
- 有効な値: プロパティに使用できる値をリストします。
- サブカテゴリ: プロパティのサブカテゴリを示します。
- デフォルト値: プロパティに推奨される値です。
- 説明: プロパティに関する情報を提供します。
- 値: プロパティの実際の値です。
- グローバル: このプロパティの値がすべてのクラスタ・ノードで共有されることを示します。
- 再起動が必要: 新しい値が有効になるように、アプリケーション・サーバーを再起動する必要があるかどうかを示します。
「値」フィールドに、このプロパティの値を入力します。
「保存」をクリックします。
構成するプロパティごとに手順2から6を繰り返します。
保存したプロパティのrestart_requiredがtrueに設定されている場合、新しい値が有効になるようにアプリケーション・サーバーを再起動します。

1.3.3 プロパティの追加

一部の構成タスクでは、システムに対して新しいカスタム・プロパティを追加する必要があります。たとえば、結果セットのキャッシュを実装する場合、キャッシュの値を設定する任意のWebCenter Sitesデータベース表に対して最大3つのプロパティを作成できます。(結果セット・キャッシュの詳細は、『Oracle WebCenter Sitesでの開発』の結果セット・キャッシュおよび問合せの操作に関する項を参照してください。)すべてのカスタム・プロパティはwcs_properties.jsonファイルに追加されます。

WebCenter Sitesシステムにプロパティを追加する手順:

プロパティ管理ツールを「プロパティ管理ツールへのアクセス」に記載されているように開きます。
「追加」をクリックします。
新しいプロパティ・フォームがプロパティ管理ツールの「プロパティ」セクションで開きます。
次のフィールドに新しいプロパティの値を入力します。
- キー: 追加する必要のあるプロパティの名前を入力します。
- 有効な値: プロパティに使用できる値を入力します。
- カテゴリ: カスタム。この値はwcs_properties.jsonファイルのプロパティのCategoryパラメータに示されます。
- デフォルト値: このプロパティに推奨される値を入力します。
- サブカテゴリ:このプロパティのサブカテゴリ(存在する場合)を入力します。
- 値: プロパティの値を設定します。
- 説明: このプロパティの説明を入力します。
- グローバル: プロパティとその値がすべてのクラスタ・ノードで共有される必要があることを示すには、このチェック・ボックスを選択します。
- 再起動が必要: 新しいプロパティと値を有効にするためにアプリケーション・サーバーを再起動する必要がある場合に、このチェック・ボックスを選択します。
「保存」をクリックします。
restart_requiredフラグがtrueに設定されている場合、新しい値が有効になるようにアプリケーション・サーバーを再起動します。

1.3.4 プロパティの削除

プロパティを削除する必要はほとんどありません。ただし、プロパティを削除する必要がある場合は次の手順を参照します。

注意:

削除できるのは、カスタム・プロパティのみです。必要なプロパティは絶対に削除しないでください。

プロパティ管理ツールを開きます。(「プロパティ管理ツールへのアクセス」を参照してください。)
構成するプロパティを検索します(検索の情報については手順2を参照してください)。
検索条件に一致するプロパティがページの「プロパティ」セクションにリストされます。
削除するプロパティの名前をクリックします。
なんらかの理由でプロパティをリストアする必要がある場合は、そのプロパティの現在の値に注意してください。
「削除」をクリックします。
確認メッセージが表示されます。
「はい」をクリックします。
削除したプロパティのrestart_requiredフラグがtrueに設定されていた場合、変更内容が有効になるようにアプリケーション・サーバーを停止して再起動します。

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

WebCenter Sitesが実行していない場合、インポート/エクスポート・ユーティリティを使用して、WebCenter Sites JSONファイル・プロパティをプロパティ・ファイル形式(.iniまたは.properties)でインポートおよびエクスポートします。エクスポートされたプロパティ・ファイルには、WebCenter Sitesのkey=value形式のすべてのプロパティが含まれます。このエクスポートされたプロパティ・ファイルは変更することができ、変更された設定をWebCenter Sitesにインポートできます。

注意:

WebCenter Sitesが実行していない場合、インポート/エクスポート・ユーティリティを使用してプロパティ値を更新できます。WebCenter Sitesが実行していて、カスタム・プロパティを追加している場合のプロパティ値の変更を含む、その他のすべてのプロパティの変更では、プロパティ管理ツールを使用します。

エクスポート/インポート・ユーティリティにアクセスするためのコマンドは次のとおりです。

Windowsシステムの場合、propertiesUtility.batコマンド・ファイルを使用します。次に例を示します。

propertiesUtility.bat <sites_home> <config_folder> export <properties_file>
Unixシステムの場合、propertiesUtility.shコマンド・ファイルを使用します。各コマンド・パラメータはスラッシュ(/)で区切ります。次に例を示します。

propertiesUtility.sh /oracle/sites-home /oracle/config export /export/my_config.properties

次の手順では、propertiesUtility.batコマンド・ファイルを使用します。

インポート/エクスポート・ユーティリティを実行する手順:

コマンド・プロンプト・ウィンドウを開き、sites-home/binディレクトリにcdします。
プロパティをJSONファイルから選択したプロパティ・ファイル(.iniまたは.properties)にエクスポートします。
```
>propertiesUtility.bat <sites_home> <config_folder> export <properties_file>
```
たとえば、JSONファイルのプロパティをmy_config.propertiesファイルにエクスポートするには、次のエクスポート・コマンドを入力します。
```
>propertiesUtility.bat c:/oracle/sites-home C:/oracle/config export 
   c:/export/my_config.properties
```
ユーティリティはプロパティ・ファイルを、エクスポート・コマンドで指定したディレクトリに作成します。
プロパティ・ファイルに移動し、テキスト・エディタで開きます。プロパティはkey=value形式でリストされています。必要なプロパティの値を変更してから、プロパティ・ファイルを保存します。
クラスタ・ノード特有の値を含むキーの場合、変更が行われるノードの名前が接尾辞として(---NodeName) keyに追加されます。たとえば、valid.urlsキーの場合、プロパティ・ファイルには2エントリが存在するようになります。
- valid.urls=some_value
- valid.urls---nodeA=some_value_specific_to_nodeA
更新されたプロパティをJSONファイルにインポートします。
- WebCenter Sitesが実行していない場合、次のコマンドを使用します。
```
>propertiesUtility.bat <sites_home> <config_folder> import <properties_file>
```
  ここで、<properties_file>は更新されたプロパティを含むプロパティ・ファイルへのパスで、<config_folder>はconfigフォルダへのパスです。
- WebCenter Sitesが実行していて、更新をインポートして、その変更ですべてのWebCenter Sitesインスタンスを動的に更新する場合、次のように、フラッシュ・フラグをインポート・コマンドに追加します。
```
>propertiesUtility.bat <sites_home> <config_folder> import <properties_file> 
   [flush sites-url]
```
  次に例を示します。
```
>propertiesUtility.bat c:/oracle/sites-home C:/oracle/config import c:/import/
    my_config.properties flush http://localhost:8080/sites
```
  flushフラグは、構成設定を保存するWebCenter Sitesのキャッシュを無効にします。flushフラグでは、ローカルのWebCenter Sitesインスタンス(sites-url)のURLを指定する必要があります。
更新されたプロパティ値は、JSONファイルにインポートされます。動的にWebCenter Sitesを更新する引数を指定した場合、変更を即時に確認できます。システムが実行していない場合、変更は起動時に有効になります。