7.6 SYSTEMパッケージ変数

QUERYおよびCOOKIE以外に、WebScriptが用意する変数が属するパッケージです。システムパッケージに変数を作ることはできません。

値の有効範囲はローカルです。次のフォーマットファイルを処理するときに、同じ変数が存在することは、一般には保証されません。また、変数が存在している場合でも、値が同じであることは、一般には保証されません。

SYSTEM::DB_ERRORCODE

データベースエラーコードを参照する変数です。
<!DO>タグによるSQL文の実行、<!ABORT>タグまたは<!TRANSACTION>タグによるトランザクション処理を実行した場合に、エラーが発生したかどうかを識別する変数です。
フォーマットファイル内で値を設定することはできません。

参照

エラーコードとして、SQLSTATE値を指定します。SQLSTATE値については、“SQLリファレンス”の“SQLSTATE値”を参照してください。

エラーコードの値を識別する場合は、その値を文字列として扱ってください。

アプリケーション環境パラメタのDBErrorHandleで、データベースのエラー処理を行うことを指定していない場合は、<!ERRORHANDLE>拡張タグで、データベースタイプにONを指定して、エラー処理を行うことを指定する必要があります。

例 SQLSTATE値が"3F000"の場合

<!ERRORHANDLE ON TYPE=DB>
<!DO "SELECT NAME FROM SCM.SAMPLE"  RESULT=DATA>
<!IF 'SYSTEM::DB_ERRORCODE ne "00000"'>
    <!IF 'SYSTEM::DB_ERRORCODE eq "3F000"'>
      : 
    <!/IF>
      : 
<!/IF>
<!ERRORHANDLE DEFAULT TYPE=DB>

SYSTEM::DB_ERRORMSG

データベースエラーメッセージを参照する変数です。
<!DO>タグによるSQL文の実行、<!ABORT>タグまたは<!TRANSACTION>タグによるトランザクション処理を実行した場合に、エラーの内容を通知するエラーメッセージが設定されます。
フォーマットファイル内で値を設定することはできません。

例 SELECT文でのエラー原因メッセージの出力

<!DO "SELECT NAME FROM SCM.SAMPLE"  RESULT=DATA>
<!IF 'SYSTEM::DB_ERRORCODE ne "00000"'>
    <!HREPLACE SYSTEM::DB_ERRORMSG>
    <!ABORT>
<!/IF>

SYSTEM::LAST_DB_ERRORCODE

データベースエラーコードを参照する変数です。

Symfoware Serverのログインから現在までの、最後に出力されるSQLのエラーコードの値です。ログイン直後の値は、"00000"です。ただし、wit_gwdコマンドで、WIT_error=yesが指定された場合、ログインでエラーが発生したならば、ログインエラーのエラーコードが設定されます。

本変数の値は、変更できます。
使用例については、“SYSTEM::LAST_DB_ERRORMSG”を参照してください。

SYSTEM::LAST_DB_ERRORMSG

データベースエラーメッセージを参照する変数です。

Symfoware Serverのログインから現在までの、最後に出力されるSQLのエラーメッセージの値です。ログイン直後の値は、""（空文字列）です。ただし、wit_gwdコマンドで、WIT_error=yesが指定され、ログインでエラーが発生した場合は、ログインエラーのエラーメッセージが設定されます。

本変数の値は、変更できます。

例

<!ERRORHANDLE ON>
<!SETVAR SYSTEM::LAST_DB_ERRORCODE "normal">
<!DO "INSERT ～">
<!DO "INSERT ～">
<!DO "INSERT ～">
<!IF 'SYSTEM::LAST_DB_ERRORCODE ne "normal"'>
  エラーが発生しました。<!REPLACE SYSTEM::LAST_DB_ERRORMSG><BR>
<!/IF>

SYSTEM::WL_ERRORCODE

WebScriptエラーコードを参照する変数です。

WebScriptの動作中に、エラーを検出した場合、メモリアロケーションエラーまたは通信エラーが発生した場合のエラーコードが設定されます。設定されるエラーコードの詳細は、“付録C WebScriptエラーコード一覧”を参照してください。

フォーマットファイル内で値を設定することはできません。

アプリケーション環境パラメタのWLErrorHandleで、WebScriptのエラー処理を行うことを指定していない場合は、<!ERRORHANDLE>拡張タグで、WebScriptタイプにONを指定してエラー処理を行うことを指定する必要があります。

SYSTEM::LOGIN_NAME

ログインユーザIDを参照する変数です。

セションのログインユーザIDを参照することができます。

フォーマットファイル内で値を設定することはできません。

SYSTEM::LOGIN_SYSTEM

ログイン中のRDBシステム名を参照する変数です。

セションのRDBシステム名を参照することができます。

フォーマットファイル内で値を設定することはできません。

SYSTEM::LOGIN_DATABASE

アクセス対象のデータベース名を参照する変数です。

ログイン直後の値は、ログインしたときのデータベース名です。

データベース設定文の設定が成功した場合、本変数の値は、データベース設定文に指定されたデータベース名に変更されます。

本変数の値を変更することはできません。

SYSTEM::LOGIN_SCHEMA

表名の指定時で、スキーマ名を省略した場合に、スキーマ名を参照する変数です。

ログイン直後の値は、ログインしたときのユーザIDです。

スキーマ設定文の設定が成功した場合、本変数の値は、スキーマ設定文に指定されたスキーマ名に変更されます。

本変数の値を変更することはできません。

SYSTEM::MAX_RESULTNUM

最大検索結果数を設定する変数です。

<!DO>によって検索を行う前に、MAX_RESULTNUMに最大検索件数を指定することで、<!DO>タグによる検索の結果数を制御することができます。

設定可能な範囲は、0から2,147,483,647までです。なお、0が設定された場合または省略した場合は、65,535が設定されます。

この変数は、任意の時点で更新できます。

SYSTEM::TIMEOUT

フォーマットファイルがタイムアウトによって、処理されているかどうかを判定する変数です。

この変数は、アプリケーション環境パラメタlogoutFormatで指定されたフォーマットファイル中で使用すると効果的です。

フォーマットファイルの中で、TIMEOUTを参照することにより、現在処理しているフォーマットファイルがタイムアウトによって処理されているのか、あるいはwit_logoutコマンドで処理されるかを識別することができます。

タイムアウトによって処理されている場合は、TIMEOUTに1が設定され、そうでない場合は、0が設定されます。

フォーマットファイル内で値を設定することはできません。

SYSTEM::GWD

WebScriptコマンドのパスを参照する変数です。

現在のWebScriptを使用している環境で、wit_gwdコマンドを実行するためのURLの絶対パス部分が設定されています。なお、WebScriptは、この変数を設定するためにアプリケーション環境パラメタWLCommandPathを使用していますので、このパラメタの値を正しく設定しておくことが必要です。

フォーマットファイル内で値を設定することはできません。

SYSTEM::FMTR

WebScriptコマンドのパスを参照する変数です。

現在のWebScriptを使用している環境で、wit_fmtrコマンドを実行するためのURLの絶対パス部分が設定されています。なお、WebScriptは、この変数を設定するためにアプリケーション環境パラメタWLCommandPathを使用していますので、このパラメタの値を正しく設定しておくことが必要です。

フォーマットファイル内で値を設定することはできません。

SYSTEM::MEDIA

WebScriptコマンドのパスを参照する変数です。

現在のWebScriptを使用している環境で、wit_mediaコマンドを実行するためのURLの絶対パス部分が設定されています。なお、WebScriptは、この変数を設定するためにアプリケーション環境パラメタWLCommandPathを使用していますので、このパラメタの値を正しく設定しておくことが必要です。

フォーマットファイル内で値を設定することはできません。

SYSTEM::LOGOUT

WebScriptコマンドのパスを参照する変数です。

現在のWebScriptを使用している環境で、wit_logoutコマンドを実行するためのURLの絶対パス部分が設定されています。なお、WebScriptは、この変数を設定するためにアプリケーション環境パラメタWLCommandPathを使用していますので、このパラメタの値を正しく設定しておくことが必要です。

フォーマットファイル内で値を設定することはできません。

SYSTEM::OS

WebScriptが動作しているサーバのOS種別を参照する変数です。

Solarisの場合
“Solaris”が設定されます。

Linuxの場合
“Linux”が設定されます。

Windowsの場合
“WindowsNT”が設定されます。

フォーマットファイル内で値を設定することはできません。

SYSTEM::SCRIPT_CODE

WebScriptセションが動作するSymfoware/RDBのロケールを参照する変数です。

Solarisの場合
“C”、“EUC”、“SJIS”、または“UNICODE”が設定されます。

Linuxの場合
“C”、“EUC”、または“UNICODE”が設定されます。

Windowsの場合
“C”、または“SJIS”が設定されます。

フォーマットファイル内で値を設定することはできません。

SYSTEM::DB_CODE

WebScriptがセションを開設しているデータベースの文字コード系を参照する変数です。

Solarisの場合
“EUC”、“SJIS”、または“UNICODE”が設定されます。

Linuxの場合
“EUC”、または“UNICODE”が設定されます。

Windowsの場合
“SJIS”、または“UNICODE”が設定されます。

フォーマットファイル内で値を設定することはできません。

SYSTEM::SYMFOWARE_EDITION

Symfoware Serverのエディションを参照する変数です。

Symfoware Server Enterprise Extended Editionの場合、“EEE”が設定されます。
Symfoware Server Enterprise Editionの場合、“EE”が設定されます。
Symfoware Server Standard Editionの場合、“SE”が設定されます。

SYSTEM::SYMFOWARE_AREA

Symfoware Serverの国内版か海外版かを参照する変数です。

国内版の場合、“japan”が設定されます。
海外版の場合、“other”が設定されます。