ABAP ディクショナリの入力ヘルプ 

ABAP ディクショナリから利用できる主な入力ヘルプの形式は検索ヘルプです。検索ヘルプは、ABAP ディクショナリで登録する独立したリポジトリオブジェクトです。これは、Dynpro 項目への入力ヘルプの表示に使用されます。検索ヘルプはテーブル項目やデータエレメントにリンクすることができます。検索ヘルプだけではなく、例外的な状況では、チェックテーブル、固定値、静的入力ヘルプも使用することができます。

入力ヘルプのメソッド

ｷ        検索ヘルプ

検索ヘルプには、基本と複合の 2 種類があります。基本検索ヘルプは検索パスを表します。該当対象一覧のデータの場所、Dynpro と選択したメソッド間の値の交換方法、およびユーザが入力ヘルプを選択した際に発生するユーザダイアログを定義します。複合検索ヘルプは、2 つ以上の基本検索ヘルプで構成されています。複合検索ヘルプには、項目の一連の検索パスが含まれ、そのすべてが有用といえます。複合検索ヘルプは、Dynpro と多様な基本検索ヘルプとのインタフェースです。

ｷ        チェックテーブル

ABAP ディクショナリを使用すると、外部キーを使用してテーブル間の関係を定義することができます。依存テーブルは外部キーテーブルと、参照テーブルはチェックテーブルと呼ばれます。チェックテーブルのキー項目のそれぞれが外部キーテーブルの項目に対応します。これらの項目は、外部キー項目と呼ばれます。外部キー項目の 1 つが値の有効性をチェックするチェック項目として指定されます。チェックテーブルのキー項目は、チェック項目の入力ヘルプとして機能します。

ｷ        固定値

ABAP ディクショナリのドメインが取得できる値に固定値を割り当てて、その値を制限することができます。固定値は、そのドメインを使用して定義された項目の入力ヘルプとして使用できます。ただし、ドメインの値テーブルは入力ヘルプに使用されません。値テーブルは、ドメインを参照する項目のチェックテーブルのデフォルト値としてのみ使用されます。

ｷ        静的入力ヘルプ

データ型 DATS および TIMS の項目には、入力ヘルプとして使用でき、独自に事前設定されたカレンダとクロックヘルプがあります。

ABAP ディクショナリの入力ヘルプ階層

検索ヘルプを、データベーステーブルの項目や構造のコンポーネントとリンクする方法はさまざまです。ユーザが利用できる入力ヘルプは、リンクのタイプによって異なります。次の一覧は使用される入力ヘルプを優先度の低いものから順に示しています。

...

       1.      カレンダおよびクロックヘルプ

データ型 DATS または TIMS の項目に他の入力ヘルプが定義されていない場合は、カレンダまたはクロックヘルプが表示されます。

       2.      ドメインの固定値

項目にチェックテーブルや検索ヘルプがない場合、基盤となるドメインの任意の固定値が使用されます。

       3.      データエレメントの検索ヘルプ

ABAP ディクショナリからの検索ヘルプをデータエレメントに割り当てることができます。項目にチェックテーブルや独自の検索ヘルプがない場合は、基盤となるデータエレメントに割り当てられた検索ヘルプが使用されます。

       4.      チェックテーブル

チェックテーブルにテキストテーブルや独自の検索ヘルプがなく、項目にも独自の検索ヘルプがない場合、チェックテーブルのキー項目の内容が入力ヘルプとして使用されます。

       5.      テキストテーブルのあるチェックテーブル

テーブルにテキストテーブルを定義することができます。項目のチェックテーブルにテキストテーブルが定義されている場合、入力ヘルプにはチェックテーブルのキー項目とユーザのログオン言語によるテキストテーブルからの対応テキストの両方が表示されます。

       6.      検索ヘルプのあるチェックテーブル

検索ヘルプは、項目のチェックテーブルに割り当てることができます。チェックテーブルの値とともに検索ヘルプが表示されます。ただし、複数のパラメータの値を転送することもできます。

       7.      項目の検索ヘルプの表示

検索ヘルプは、直接、構造またはデータベーステーブルの項目に割り当てることができます。これは優先度が最も高く、入力ヘルプに常に表示されます。このため、検索ヘルプを割り当てるときは、必ずチェックテーブルにも入力されている値のみが提示されるようにする必要があります。このように設定しておかないと、自動入力チェックでエラーが発生する恐れがあります。

検索ヘルプと値の移送

検索ヘルプにはインタフェース ( 検索ヘルプパラメータ) があります。これにより、すでにユーザが画面に入力したエントリのいずれを該当対象一覧のコンパイルに使用するか、ユーザがエントリを選択した際に入力される Dynpro 項目が決定されます。検索ヘルプのパラメータは、インポートパラメータとエクスポートパラメータに分類されます。パラメータは、Import パラメータと Export パラメータとして同時に機能させることもできます。

ユーザが入力ヘルプを起動すると、Dynpro 上の項目の内容が検索ヘルプのインポートパラメータに渡されます。検索ヘルプがデータエレメントに当てられている場合、あるいは Dynpro 項目に直接割り当てられている場合、検索ヘルプパラメータ 1 つのみが項目に割り当てられ、項目からこのパラメータにのみ値が移送されます。検索ヘルプがテーブルや構造項目、あるいは項目のチェックテーブルに割り当てられている場合、値の入力が必要な検索ヘルプのパラメータが複数ある場合もあります。入力ヘルプが起動され、検索ヘルプがテーブルや構造項目に割り当てられている場合、システムでは、検索ヘルプのインポートパラメータのそれぞれと同名の項目の検索が試行されます。同名の項目が検索されると、その項目の内容が検索ヘルプパラメータに転送されます。

ユーザが検索ヘルプの該当対象一覧から行を選択すると、検索ヘルプのエクスポートパラメータの値が対応する Dynpro 項目に転送されます。該当対象一覧からの値は、検索ヘルプのエクスポートパラメータとリンクされ、入力可能な Dynpro 上の項目にのみ返されます。

検索ヘルプの変更

例外的に、検索ヘルプ Exit を使用して入力ヘルプの標準フローを変更できる場合もあります。検索ヘルプ Exit は事前定義されたインタフェースのある汎用モジュールです。入力ヘルププロセス内の定義ポイントで呼び出すことができます。検索ヘルプ Exit を使用すると、後続処理を誘導したり、完全に置換する独自のプログラムロジックを格納することができます。

汎用モジュールでは、検索ヘルプの属性、該当対象一覧の事前選択に使用される選択オプション、該当対象一覧自体、後続の処理ステップを変更することができます。

検索ヘルプ Exit はすべて、汎用モジュールF4IF_SHLP_EXIT_EXAMPLE と同じインタフェースが必要です。ただし、任意の数のオプションパラメータ、特にエクスポートパラメータを追加定義することができます。インタフェースの詳細については、汎用モジュールの文書を参照してください。

検索ヘルプ Exit を検索ヘルプに割り当てると、ヘルププロセッサによって以下のポイントで呼び出されます。このポイントは、ユーザが入力ヘルプと対話を行うポイントです。検索ヘルプのフローをユーザの利益のために変更する最適なポイントであるためです。

...

       1.      検索パスを選択するダイアログボックスが表示される前

SELONE イベント ( 複合検索ヘルプのみ) 。このポイントは、検索ヘルプをトランザクション、他のシステム変数、さらには画面上のラジオボタンの状態に依存させることができます( このイベントは、複合検索ヘルプの検索ヘルプ Exit を呼び出すことができる唯一のイベントです。これ以外のイベントではすべて、選択した基本検索ヘルプの検索ヘルプ Exit を呼び出します) 。

       2.      基本検索ヘルプの選択後 ( イベント PRESEL1)

ここでは、検索パラメータを Dynpro 項目に割り当てる方法を変更するなどして、Dynpro に対する検索ヘルプの割当を変更することができます。

       3.      検索条件を入力するダイアログボックスが表示される前

(PRESEL イベント) 。ここでは、ダイアログボックスの内容を変更したり、完全に非表示にすることなどができます。

       4.      データの選択前

(SELECT イベント) 。値選択にはユーザのインタラクションがありませんが、検索ヘルプ Exit によって一部または全部を上書きすることができます。これは、SELECT 命令を使用してテーブルやビューにデータを読み込むことができない場合に必要です。

       5.      該当対象一覧の表示前

(DISP イベント) 。ここでは、ユーザの権限に応じて一覧の一定の行や列を非表示にすることなどによって該当対象一覧の表示方法を変更することができます。

       6.      ユーザが選択した行が Dynpro に返される前

(RETURN イベント) 。このポイントは、トランザクションの後続フローがユーザが選択した値によって異なる場合に役立ちます。このイベントの代表的な用途は、SPA/GPA パラメータの設定です。

一部の検索ヘルプ機能は、同様の方法で繰り返し要求されます。この一例として、動的に使用される検索ヘルプの設定が考えられます。このような場合に備えて標準汎用モジュールが作成されており、検索ヘルプ EXIT として動的に使用することも、検索ヘルプ EXIT 内で呼び出すこともできます。このような汎用モジュールにはすべて、接頭辞 F4UT_ があります。

ドメイン値テーブルのロール

リリース 4.0 以前は、ドメインの値テーブルを使用して検索ヘルプを表示することができました。現在は使用できません。この大きな理由は、値テーブルに複数のキー項目があると予測できない結果が発生する恐れがあるためです。他のキー項目を制限することはできず、チェックテーブルでは一般的に可能な項目の環境の考慮ができませんでした。

このような値ヘルプが使用されていた場合は、そのドメインを使用するデータエレメントに検索ヘルプを登録し、値テーブルを選択メソッドに使用することによって再構築することができます。

例

ABAP ディクショナリの入力ヘルプ

REPORT DEMO_DYNPRO_F4_HELP_DICTIONARY.

TABLES DEMOF4HELP.

CALL SCREEN 100.

MODULE CANCEL INPUT.
  LEAVE PROGRAM.
ENDMODULE.

Dynpro 100 の次画面 ( 静的定義) は同じ Dynpro です。これは次のようなレイアウトになります。

ABAP ディクショナリ構造 DEMOF4HELP のコンポーネントが入力項目に割り当てられています。押しボタンの機能コードは CANCEL で、機能タイプは E です。

この Dynpro 制御ロジックは次のとおりです。

PROCESS BEFORE OUTPUT.

PROCESS AFTER INPUT.
  MODULE CANCEL AT EXIT-COMMAND.

ユーザが個別の項目で入力ヘルプを選択すると、以下のように表示されます。

ｷ         日付 および時間項目は、ABAP ディクショナリ構造のコンポーネント DATE_FIELD および TIME_FIELD をそれぞれ参照します。これらのデータ型は DATS および TIMS であるため、入力ヘルプはそれぞれカレンダとクロックになります。

ｷ         選択 項目は構造コンポーネントMARK_FIELD を参照します。これには基盤になるドメイン S_FLAG があり、このドメインには固定値が 2 つあります。これが入力ヘルプとして表示されます。

ｷ         最初の航空会社項目は構造コンポーネント CARRIER1 を参照します。このコンポーネントには基盤になるデータエレメント DEMOF4DE があり、このエレメントには検索ヘルプ DEMO_F4_DE の検索ヘルプパラメータ CARRID が割り当てられています。検索ヘルプは、データベーステーブル SCARR から列 CARRID と CARRNAME を読み込みます。CARRNAME のみが表示されますが、CARRID にはエクスポートパラメータのフラグが指定されます。

ｷ         2 つめの航空会社項目は構造コンポーネント CARRIER2 を参照します。このコンポーネントにはチェックテーブル SCARR があります。さらにこのチェックテーブルには、検索ヘルプ H_SCARR が割り当てられています。これによって列 CARRID とCARRNAME が一覧表示され、エクスポートされます。

ｷ         フライト番号 項目は構造コンポーネントCONNID を参照します。検索ヘルプ DEMO_F4_FIELD が割り当てられています。検索ヘルプには CARRID と CONNID という 2 つのパラメータがあり、これらは構造のコンポーネントCARRIER2 と CONNID に割り当てられています。検索ヘルプによって CARRIER がインポートされ、データベーステーブル SPFLI から対応するデータが読み込まれ、CARRIER と CONNID に一覧表示されて、CONNID がエクスポートされます。