データウェアハウスセンター アプリケーション統合の手引き

状況情報を戻す

データウェアハウスセンター プログラムの実行後に、戻りコードがプログラムを使用したステップに戻されなければなりません。戻りコードは正の整数でなければなりません。ご使用のプログラムが戻りコードを戻さない場合、プログラムを使用しているステップは失敗します。 Error RC1 の値が 8410 である場合、データウェアハウスセンターは 「ログ詳細 (Log Details)」ウィンドウの 「エラー RC2 (Error RC2)」 フィールドに戻りコードを表示します。

データウェアハウスセンター プログラムは、以下に示す追加の状況情報をデータウェアハウスセンターに戻すことができます。

データウェアハウスセンター エージェントは、追加の状況情報をウェアハウス・サーバーに転送します。

情報をデータウェアハウスセンターに転送する

追加の状況情報をウェアハウス・エージェントに転送するために、プログラムは追加の状況情報を含むフィードバック・ファイル と呼ばれるファイルを作成しなければなりません。フィードバック・ファイルのパスおよびファイル名は、 VWP_LOG 環境変数の値でなければなりません。 (ファイル名は processid.log で、 processid はエージェント・プロセスの ID です。) エージェントは、プログラムを呼び出す前に VWP_LOG を設定します。プログラムの実行が終了した後、エージェントはフィードバック・ファイルが存在するかどうかを調べます。存在する場合、エージェントはそのファイルを処理します。存在しない場合、エージェントは何も行いません。プログラムがファイルを作成できない場合、それは実行を続ける必要があります。

フィードバック・ファイルの形式

プログラムは追加の状況情報をフィードバック・ファイルに任意の順序で書き込むことができますが、情報を識別するために以下の形式を使用しなければなりません。以下のリストに示すように、戻される各項目を開始タグ <tag> および終了タグ </tag> で囲みます。それぞれの開始タグの次には対応する終了タグがなければなりません。 2 つの開始タグを連続して使用することはできません。たとえば、以下のタグ形式は有効です。
<RC>...</RC>...<MSG>...</MSG>

以下の組み込みタグ形式は無効です。
<RC>...<MSG>...</RC>...</MSG>

フィードバック・ファイル内に以下の情報を指定できます。

戻りコード
<RC>return code</RC>。 return code は正の整数です。

戻りコード警告標識
<WARNING>1</WARNING> は、戻りコード警告標識をオンに設定します。

データウェアハウスセンター システム・メッセージ
<MSG>message text\n</MSG>

message text
1 つ以上のメッセージのテキスト

\n
改行文字。複数のメッセージがある場合、この文字を各メッセージの終わりに含めます。

コメント
<COMMENT>comment text</COMMENT>。 comment text は、コメントのテキストです。

処理されたデータの行数
<ROWS>number of rows</ROWS>。 number of rows は正の整数です。

処理されたデータのバイト数
<BYTES>number of bytes</BYTES>。 number of bytes は正の整数です。

SQLSTATE
<SQLSTATE>sqlstate string</SQLSTATE>。 sqlstate string は長さが 0 より大きく、5 桁以下の任意のストリングです。

図 77 は、フィードバック・ファイルの例を示しています。

図 77. フィードバック・ファイルの例

<RC> 20</RC>
<ROWS>2345</ROWS>
<MSG>The parameter type is not correct</MSG>
<COMMENT> Please supply the correct parameter type (PASSWORD
     NOTREQUIRED, GETPASSWORD, ENTERPASSWORD)</COMMENT> 
<BYTES> 123456</BYTES>
<WARNING> 1</WARNING>
<SQLSTATE>12345</SQLSTATE>

フィードバックによってステップ状況を判別する方法

Log Viewer に表示されるプログラムの戻りコードおよびステップ状況には、さまざまなものがあります。それらはプログラムによって設定される以下の値に依存します。

表 144 は、これらの値の可能な組み合わせと、それぞれの組み合わせから生じる結果とを示しています。

表 144. フィードバック・ファイルの状態および結果
状態 結果
ステップ状況1 エラー RC1 および RC2 の値
データウェアハウスセンター プログラムの戻りコードが 0 フィードバック・ファイルが存在しない2 成功

RC1 = 0; RC2 = 0

フィードバック・ファイルが存在する2 フィードバック・ファイル内の <RC> の値が 03 <WARNING> がフィードバック・ファイル内で設定されていない 成功

RC1 = 0; RC2 = 0

フィードバック・ファイル内の <WARNING> の値が 1 警告

RC1 = 0; RC2 = 0

フィードバック・ファイル内の <RC> の値が 0 ではない3 <WARNING> がフィードバック・ファイル内で設定されていない 失敗

RC1 = 8410 (プログラムは失敗した)、 RC2 = フィードバック・ファイル内の <RC> の値

フィードバック・ファイル内の <WARNING> の値が 1 警告

RC1 = 0、 RC2 = フィードバック・ファイル内の <RC> の値

データウェアハウスセンター プログラムの戻りコードがゼロではない フィードバック・ファイルが存在しない2 失敗

RC1 = 8410 (データウェアハウスセンター プログラムは失敗した)、 RC2 = データウェアハウスセンター プログラムによって戻されるコード

フィードバック・ファイルが存在する2 フィードバック・ファイル内の <RC> の値が 03 <WARNING> がフィードバック・ファイル内で設定されていない 成功

RC1 = 0; RC2 = 0

フィードバック・ファイル内の <WARNING> の値が 1 警告

RC1 = 0; RC2 = 0

フィードバック・ファイル内の <RC> の値がゼロではない <WARNING> がフィードバック・ファイル内で設定されていない 失敗

RC1 = 8410 (データウェアハウスセンター プログラムは失敗した)、 RC2 = データウェアハウスセンター プログラムによって戻されるコード

フィードバック・ファイル内の <WARNING> の値が 1 警告

RC1 = 0、 RC2 = フィードバック・ファイル内の <RC> の値

注:

  1. 「進行中の作業 (Work in Progress)」ウィンドウに表示される、ステップの処理状況。

  2. プログラムの戻りコードが 0 であってもなくても、データウェアハウスセンターはフィードバック・ファイルが存在するかどうかを検査します。

  3. データウェアハウスセンターは常に、フィードバック・ファイル内の <RC> の値を「ログ詳細 (Log Details)」ウィンドウ内の 「RC2」フィールドの値として表示します。


[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]