ダイアログマネージャの使用

ダイアログマネージャは、アプリケーションコンポーネントの実行を制御する WebFOCUS 言語の一部です。ダイアログマネージャのコマンドおよび変数を使用することで、アプリケーションのフローを制御することができます。プロシジャの実行を動的に制御できるため、柔軟にアプリケーションを設計することができます。また、ダイアログマネージャを使用すると、プロシジャに変数を使用し、実行時にその値を指定することもできます。

次の説明は、ダイアログマネージャの代表的な使用方法です。

• 変数によるプロシジャのカスタマイズ   変数を使用してプロシジャの実行を動的に変更したり、システムから情報を取得したりすることができます。
• プロシジャ実行順序の制御   リクエストの条件付き実行、プログラムループを使用した繰り返し実行、別のプロシジャの呼び出しを行えます。
• HTML Web ページの拡張   プロシジャに HTML コマンドを追加して、Web ページの機能を拡張することができます。
• オペレーティングシステムコマンドの発行   オペレーティングシステムコマンドを発行して、リクエストを実行する環境をセットアップすることができます。
• パスワードの管理   パスワードの割り当ておよび変更を直接実行することができます。
• アプリケーションへのメッセージの送信   プロシジャの処理中にアプリケーションにメッセージを送信し、プロシジャの目的、結果、役立つ情報などを表示することができます。

ダイアログマネージャの IF、GOTO、LABEL、REPEAT を作成することができます。また、ダイアログマネージャキャンバスを開き、その他の項目を手動で作成することもできます。

ダイアログマネージャ変数の概要

プロシジャに変数を追加し、実行時に変数値のユーザ入力を要求することができます。これにより、プロシジャの実行ごとに入力値を変更することで、ユーザによるプロシジャのカスタマイズが可能になります。変数は次の 2 つに分類されます。

• ローカル変数とグローバル変数   ローカル変数およびグローバル変数の値は、実行時に指定する必要があります。ローカル変数の値は、1 つのプロシジャでのみ保持されます。グローバル変数の値は、明示的にクリアしない限り、複数のプロシジャで保持されます。ローカル変数を作成するには、変数名の先頭にアンパサンド (&) を 1 つ付けます。グローバル変数を作成するには、変数名の先頭に 2 つのアンパサンド (&&) を付けます。
• システム変数と統計変数   システム変数および統計変数の値は、プロシジャが変数を参照する際にシステムから自動的に渡されます。システム変数および統計変数は、名前の先頭にアンパサンド (&) が 1 つ付いています。たとえば、&LINES は、生成された出力行数を示す変数です。&DATE は、現在の日付を示す変数です。

ダイアログマネージャの処理

ダイアログマネージャのストアドプロシジャにコマンドおよび変数を追加することで、実行時にユーザ入力と環境条件に基づいてアプリケーションをカスタマイズすることができます。

WebFOCUS App Studio では、ストアドプロシジャは「プロシジャ」と呼ばれます。

1. 実行するプロシジャが呼び出されると、コマンドプロセッサから処理が開始されます。
2. FOCEXEC プロセッサがプロシジャの各行を読み取ります。読み取られた行に変数がある場合、変数に現在値が割り当てられます。
3. ダイアログマネージャで読み取られたダイアログマネージャコマンドはすぐに実行されます。
4. ダイアログマネージャコマンドが含まれていないコマンド行が完全に展開され、-SET コマンドまたは入力要求により変数の値が解決されると、そのコマンド行はコマンド実行スタックに配置されます。
5. ダイアログマネージャ実行コマンドおよび統計変数は、現在スタックされているコマンドのすべてを WebFOCUS コマンドプロセッサに転送します。

プロシジャの実行準備が完了するまでに、次の処理が実行されます。

• すべての変数に値が割り当てられ、これらの値が、変数が含まれたコマンド行に統合されます。
• ダイアログマネージャコマンドにより、WebFOCUS コマンドが正しい実行順序に配置されます。
• この時点で WebFOCUS コマンドプロセッサにはダイアログマネージャコマンドは存在しなくなります。存在するのは、スタックに配置された WebFOCUS コマンド行のみです。

-TYPE コマンドを使用して、プロシジャの処理中にメッセージを画面に送信することができます。通常、このメッセージは次の目的で使用されます。

• プロシジャの目的を説明する。
• プロシジャの結果またはプロシジャのテスト中の計算結果を表示する。
• その他の役立つ情報を表示する。
• 値の入力を要求する際に、指定する情報のタイプを提示する。

プロシジャ実行順序の制御

次の方法を使用して、プロシジャの実行順序を制御することができます。

• 無条件分岐   コントロールをラベルに転送します。
• 条件分岐   テスト結果に基づいてコントロールをラベルに転送します。
• ループ   1 つの関数をプロシジャ内で繰り返し実行します。
• 別のプロシジャの呼び出し   別のプロシジャの一部または全体を現在のプロシジャに組み込みます。

無条件分岐

-GOTO コマンドを使用して、指定したラベルにコントロールを転送する無条件分岐を実行することができます。

ダイアログマネージャは、プロシジャの検索をはじめて実行する際に、検出したラベルのアドレスをすべて記録します。これにより、これらのラベルを次に使用する際に即座に見つけることができます。ダイアログマネージャが -GOTO コマンドで指定されたラベルのアドレスを記録していない場合、ダイアログマネージャはプロシジャを順方向へ検索し、ターゲットラベルを見つけます。ラベルが見つからない場合、ダイアログマネージャはプロシジャの先頭から検索を開始します。

-GOTO と関連付けられていないラベルを検出しても、ダイアログマネージャは何も実行しません。-GOTO に対応するラベルが見つからない場合、プロシジャの実行が中断し、メッセージが表示されます。

無条件分岐

-GOTO label 
  .
  .
  .
-label [TYPE text]

-GOTO DONE
TABLE FILE SALES
PRINT UNIT_SOLD RETURNS
BY PROD_CODE,CITY
END 
-RUN 
-DONE

条件分岐

条件分岐は、-IF... GOTO コマンドを使用して変数値をテストし、テスト結果に基づいて指定したラベルにコントロールを転送します。これにより、リクエストの実行を制御できるため、プロシジャで実行する部分と実行しない部分を選択することで動的なプロシジャの作成が可能になります。

たとえば、稼動中のデータソースから抽出ファイルが作成されたかどうかを確認することができます。抽出ファイルが存在する場合は、プログラムはその抽出ファイルに対して一連のレポートを実行します。抽出ファイルが存在しない場合は、プログラムはレポートを回避して分岐し、ログファイルにメッセージを書き込みます。

注意：通常、-IF テストでは、テストごとにターゲットラベルを指定する必要はありません。ただし、一連のテストが互いにネストされた複合 IF テストでは、テストごとにターゲットラベルを指定する必要があります。

条件分岐

-IF expression [THEN] {GOTO label1|CONTINUE} [ELSE IF...] [ELSE {GOTO label2|CONTINUE}] ;

1. -IF &PROC EQ 'EMPLOYEE' GOTO EMPLOYEE; 
2. -SALES
   TABLE FILE SALES
   SUM UNIT_SOLD
    BY PROD_CODE
   END 
3. -EXIT
   -EMPLOYEE
   TABLE FILE EMPLOYEE
   PRINT PLANT_NAME
    BY DEPARTMENT
   END

プロシジャでのループの実行

-REPEAT コマンドを使用してプロシジャ内にループを作成することにより、同一の処理を繰り返し実行することができます。ループは、さまざまな処理に使用することができます。たとえば、ループを使用してインデックス付き変数に値を挿入したり、1 つ目のリクエストの結果を 2 つ目のリクエストに使用したりできます。

処理ループは、指定した回数だけ実行したり、条件が満たされるまで実行したりすることができます。ループは、次のいずれかが発生した場合に終了します。

• ループが完了した場合。
• -EXIT コマンドが発行された場合。
• -GOTO が発行されて、ループ外のラベルに移動する場合。

  注意：プロシジャ内で別の -GOTO を発行して再度ループに戻った場合、そのループは前回の終了位置から続行されます。

-SET コマンドを使用すると、別の方法でループを実装することができます。

ヒント：固定レコード長 (80 バイト) 以外の変数が使用されたプロシジャでは、ループの処理中に、-REPEAT または -GOTO コマンドのターゲットとして指定されたラベルの検索に時間を要します。この場合、実行速度を向上させるには、ループの代わりに EX または -INCLUDE コマンドを使用する方法を検討してください。

ループの指定

-REPEAT label n TIMES

-REPEAT label WHILE condition;

-REPEAT label FOR &variable [FROM fromval] [TO toval] [STEP s]

-REPEAT label n TIMES

-REPEAT LAB1 2 TIMES
-TYPE INSIDE
-LAB1 TYPE OUTSIDE

INSIDE
INSIDE
OUTSIDE

-REPEAT label WHILE condition;

-SET &A = 1;
-REPEAT LABEL WHILE &A LE 2;
-TYPE &A
-SET &A = &A + 1;
-LABEL TYPE END: &A

1
2
END:3

-REPEAT label FOR &variable FROM fromval TO toval STEP s

-REPEAT LABEL FOR &A STEP 2 TO 4
-TYPE INSIDE &A
-LABEL TYPE OUTSIDE &A

INSIDE 1
INSIDE 3
OUTSIDE 5

プロシジャでの変数の使用

プロシジャに動的な変数代入を使用することで、実行時に変数値の入力を要求するプロシジャを作成することができます。この変数には文字列または数値が格納されます。この変数は、プロシジャの任意の位置に配置することができます。たとえば、フィールド、コマンド、説明テキスト、ファイル名を参照する変数を作成することができます。

注意：ダイアログマネージャ変数には、文字データのみが格納されます。関数または式からダイアログマネージャ変数に数値が返された場合、その値は整数に切り捨てられ、文字フォーマットに変換されてから変数に格納されます。

変数は次の 2 つに分類されます。

• ローカル変数およびグローバル変数の値は、実行時に指定します。ローカル変数の値は、そのプロシジャでのみ有効ですが、グローバル変数の値は、セッション中に実行されるプロシジャすべてで有効になります。

  先頭の 2 つのアンパサンド (&&) は、その変数がグローバル変数であることを示します。その他すべてのダイアログマネージャ変数は、1 つのアンパサンド (&) で始まります。

• システム変数、統計変数、特殊変数の値は、システムが自動的に割り当てます。

1 つのプロシジャで使用可能なローカル変数、グローバル変数、システム変数、統計変数、特殊変数、インデックス変数の最大数は 1024 個です。およそ 40 個の変数は、WebFOCUS で使用するために予約されています。

変数は、プロシジャでのみ使用することができます。レポートの作成時に変数を直接使用した場合、その変数は無視されます。

クエリを実行して、使用する各タイプの変数の値を取得することができます。

変数の値は、さまざまな方法で指定することができます。

ローカル変数およびグローバル変数の名前規則

変数名の指定

&[&]name

ローカル変数

ローカル変数は、変数名の先頭に付けられた 1 つのアンパサンド (&) で識別されます。ローカル変数の値は、1 つのプロシジャでのみ有効です。

TABLE FILE SALES
HEADING CENTER
"MONTHLY REPORT FOR &CITY"
"PRODUCT CODES FROM &CODE1 TO &CODE2"
" "
SUM UNIT_SOLD AND RETURNS AND COMPUTE
RATIO/D5.2 = 100 * (RETURNS/UNIT_SOLD);
BY CITY
IF CITY EQ &CITY
BY PROD_CODE
IF PROD_CODE IS-FROM &CODE1 TO &CODE2
END

EX SLRPT CITY = STAMFORD, CODE1=B10, CODE2=B20

TABLE FILE SALES
HEADING CENTER
"MONTHLY REPORT FOR STAMFORD"
"PRODUCT CODES FROM B10 TO B20"
" "
SUM UNIT_SOLD AND RETURNS AND COMPUTE
RATIO/D5.2 = 100 * (RETURNS/UNIT_SOLD);
BY CITY
IF CITY EQ STAMFORD
BY PROD_CODE
IF PROD_CODE IS-FROM B10 TO B20
END

グローバル変数

グローバル変数は、ローカル変数とは異なり、変数値が一度指定されると、-SET コマンドで別の値が設定されるか、LET CLEAR コマンドで値がクリアされない限り、WebFOCUS セッション中は変数値が保持されます。グローバル変数は、作業セッションの開始時に値を収集し、後続の複数のプロシジャで使用できるという点で便利です。特定のグローバル変数を使用するすべてのプロシジャには、WebFOCUS セッションを終了しない限り、変数の現在値が渡されます。

グローバル変数を定義するには、変数名の先頭に 2 つのアンパサンド (&&) を追加します。グローバル変数とローカル変数に同一の名前を使用することも可能です。これらの変数は互いに区別され、それぞれに異なる値を格納することができます。

TABLE FILE SALES
HEADING CENTER
"MONTHLY REPORT FOR &&CITY"
SUM UNIT_SOLD AND RETURNS AND COMPUTE
RATIO/D5.2 = 100 * (RETURNS/UNIT_SOLD);
BY CITY
IF CITY EQ &&CITY
BY PROD_CODE
IF PROD_CODE IS-FROM &&CODE1 TO &&CODE2
END
EX PROC2

TABLE FILE SALES
HEADING CENTER
"MONTHLY REPORT FOR &&CITY AND PRODUCT &&CODE1"
PRINT UNIT_SOLD AND RETURNS AND COMPUTE
RATIO/D5.2 = 100 * (RETURNS/UNIT_SOLD);
BY CITY
IF CITY EQ &&CITY
IF PROD_CODE EQ &&CODE1
END

変数値およびパラメータ値のクエリ

2 つのダイアログマネージャコマンドを使用して、次のことを行えます。

• すべてのタイプのローカル変数、グローバル変数、システム変数の値を表示する。
• パラメータの値を変数に格納する。格納された値は、? SET コマンドを使用して検索することができます。設定を確認することができます。

また、以下のクエリ (?) コマンドを発行することで、次の変数の値を表示することもできます。

• グローバル変数   グローバル変数の値は WebFOCUS セッション中は保持されるため、値を確認したい場合にクエリコマンドを使用すると便利です。構文は次のとおりです。

  ? &&

• 統計変数   クエリコマンドを実行して、すべての統計変数の現在値を検索することができます (&FOCDISORG および &FOCERRNUM を除く)。構文は次のとおりです。

  ?STAT

変数値の表示

-? &[&variablename]

CURRENTLY DEFINED & VARIABLES: