2.6.1 SGMLプラグインの環境設定

<この項の構成>
(1) 環境情報の定義方法
(2) 設定項目
(3) 有効範囲

(1) 環境情報の定義方法

SGMLプラグインの環境情報を設定するファイルを環境定義ファイルといいます。環境定義ファイルは,プラグインごとに作成します。SGMLプラグインの環境定義ファイルは,サンプルファイルとして提供されています。

SGMLプラグインの環境情報を設定できる単位を次に示します。

優先順位は,サーバ単位>ユニット単位>システム単位です。

記述誤りなどが検出された場合,サーバは起動しますが,メッセージログに警告メッセージが出力され,誤りのある定義ファイルは無視されます。環境定義ファイルがないか,環境定義ファイルはあるが設定されていない定義がある場合は,エラーではなく,定義値なしとして処理されます。最終的に有効な値がない場合は,システムのデフォルトで動作します。

メッセージログに次のメッセージが出力されていないことを確認してください。

KFPY99999-I xxxx xxxx(xxxxx) 01001-W Invalid data found.file=aa,line=XX.bb(YY)

または

KFPY99999-I xxxx xxxx(xxxxx) 01002-W Invalid value found. file=aa,line=XX,item=bb.cc(YY)

SGMLプラグインの環境定義ファイルの定義例を次の図に示します。

図2-40 SGMLプラグインの環境定義ファイルの定義例

[図データ]

注意事項
  • 各設定項目の行末は改行で区切ってください。
  • 設定項目の途中を改行で区切らないでください。
  • 1行に設定できる文字列長は1,023バイトです。
  • #(シャープ)以降は,コメント文として扱われます。
  • 各行は,空行なしで詰めて記述してください。
  • BOM(Byte Order Mark)は使用しないでください。BOMが含まれていた場合は,通常の文字として扱います。

(2) 設定項目

SGMLプラグインを動作させる環境情報をSGMLプラグインの環境定義ファイルに定義することで,ユーザごとの環境を設定できます。設定項目を次の表に示します。なお,設定項目には,ユーザごとに,必要に応じて取得できる最大値を設定します。

表2-12 SGMLプラグインの環境定義ファイルに設定できる定義項目

種別環境設定項目パラメタ設定値環境を設定できる単位
登録・検索登録・検索同時実行指定set phs_search_waitwait,nowait,またはnowait_with_update
デフォルト:wait
サーバ
登録原文書データ保持モード指定set phs_txt_orgYまたはN
デフォルト:Y
システム,ユニット,サーバ
登録文書サイズ上限値指定set phs_document_size_max最大値:5,120キロバイト
最小値:1キロバイト
デフォルト:5,120キロバイト
システム,ユニット,サーバ
エラー処理エラーコード詳細化指定set phs_errorcode_detailoffまたはon
デフォルト:off
システム,ユニット,サーバ
XML出力接頭辞xmlの小文字変換指定set phs_change_xml_prefixYまたはN
デフォルト:Y
システム,ユニット,サーバ
登録・検索同時実行,または分割遅延登録・更新系SQL同時実行指定
登録・検索同時実行,または分割遅延登録・更新系SQL同時実行を使用するかどうかを指定します。
なお,この項目を設定できる単位は,サーバ単位だけです。
形式

set phs_search_wait=wait|nowait|nowait_with_update

  • wait
    同時実行を使用しない。
  • nowait
    登録・検索同時実行を使用する。
  • nowait_with_update
    登録・検索同時実行機能に加えて,分割遅延登録・更新系SQL同時実行を使用する。
原文書データ保持モード指定
登録テキストの原文をデータベースに保持するかどうかを指定します。原文書を保持しない場合,抽象データ型関数extractsを発行するときに,原文書出力機能を使用できなくなりますが,RDエリア使用量を節約できます。
形式

set phs_txt_org=Y|N

  • Y
    原文書を保持します。
  • N
    原文書を保持しません。
登録文書サイズ上限値指定
データベースに登録できる文書サイズの上限値を指定します。
形式

set phs_document_size_max=xxxx

エラーコード詳細化指定
SQL連絡領域にメッセージが返却される場合に,エラーコードを詳細化モードで出力するかどうかを指定します。
詳細モードで出力しない場合,SQLCODE=-997のエラーとなります。詳細化モードで出力する場合,Text Search Pluginのエラーコードが出力されます。エラーコードの詳細は「付録F.1 SQL連絡領域に出力されるメッセージの形式」を参照してください。
形式

set phs_errorcode_detail=off|on

  • off
    詳細化モードで出力しません。
  • on
    詳細化モードで出力します。
接頭辞xmlの小文字変換指定
extracts関数のXML出力で,属性名に英大文字の接頭辞"XML:"が付いている場合に英小文字の接頭辞"xml:"に変換するかどうかを指定します。
形式

set phs_change_xml_prefix=Y|N

  • Y
    英小文字の接頭辞"xml:"に変換します。
  • N
    英小文字の接頭辞"xml:"に変換しません。

(3) 有効範囲

環境定義ファイルに定義した環境情報は,サーバ開始から終了まで有効です。HiRDB稼働中に環境情報を変更した場合は,正しく動作しない場合がありますので,変更しないでください。