汎用モジュール
22.4 汎用モジュール
4. 汎用モジュール
汎用モジュール
汎用モジュールは、一言でいえば「再利用可能なプログラムの部品」です。
事前にロジックを定義しておき、後から呼び出す形で利用します。
サブルーチンと違い、汎用モジュールについては「IMPORT / EXPORT」と「何となくの処理」さえ分かっていれば、実際のロジックを意識せずに利用することが可能です。
※標準の有無
SAPの標準機能(元から用意されているもの)という意味になります。
この場合ですと、サブルーチンは、SAPの標準機能として用意されておらず、事前に自身で作成が必要という意味になります。
反対に汎用モジュールは、SAPの標準機能(元から用意されているもの)が有るという意味になります。
汎用モジュールの実装
汎用モジュールの実装には以下の3つのステップが必要です。
1.汎用グループの登録
2.汎用モジュールの登録
3.IMPORT/EXPORTの定義・ロジックの実装
1.汎用グループの登録
汎用グループとは、その名の通り汎用モジュールをまとめたものです。汎用モジュールが、1つ1つのファイルだとすると、汎用グループはそれらのファイルをまとめた「フォルダ」です。
例えば、計算汎用グループがあるとすると、その中に「日付計算汎用モジュール」「年齢計算汎用モジュール」が纏まっているようなイメージです。
汎用モジュールを新規に登録する場合は、汎用グループに登録するか、新たに汎用グループを登録する必要があります。
操作手順①
① トランザクションコード SE37 を実行する
② メニューから以下のように飛んで汎用グループ登録画面に遷移
操作手順②
画面に従って項目を埋めて、保存ボタンを押下で登録完了
2.汎用モジュールの登録
操作手順①
画面のように汎用モジュール名を記入し登録ボタンを押下
操作手順②
画面のように項目を記入し、保存
先ほど登録した汎用グループに紐づける形で汎用モジュールを登録します。この際、汎用モジュールの名称については、汎用グループで共通化されているものを定義すると情報体系の整理に役立ちます。
3.IMPORT/EXPORTの定義・ロジックの実装
汎用モジュールのIMPORTINGとEXPORTINGは、サブルーチンのUSING/CHANGINGに対応します。
汎用モジュールでは、サブルーチンのようにUSING/CHANGINGを自分でコーディングする必要がありません。
インプット・アウトプットを定義する専用のタブが存在します。
操作手順①
画面のようにインポート項目を記入
操作手順②
画面のようにエクスポート項目を記入
操作手順③
ロジックの実装
ソースを記入したら保存する。
操作手順④
操作手順③で汎用モジュールを保存後、その汎用モジュールを使用するために有効化を行います。
ただし、汎用モジュールと一緒に別のオブジェクトも有効化する必要があります。
・SAPLZG_GNELAL_MODULE_TEST
・LZG_GNELAL_MODULE_TESTTOP
・SAPLZG_GNELAL_MODULE_TESTとは
SAPLZG_GNELAL_MODULE_TEST は 汎用グループを登録すると作成されるメインプログラム(FUNCTION-POOL)となります。
新しく汎用グループの登録を行わない場合は有効化の必要はありません。
・LZG_GNELAL_MODULE_TESTTOP
LZG_GNELAL_MODULE_TESTTOP は FUNCTION-POOL 命令および汎用グループ全体のグローバルデータ宣言が含まれます。
上記をオブジェクトを作成した汎用モジュールと一緒に有効化することによって汎用モジュールを使用することができます。
汎用モジュールの呼び出し方法
汎用モジュールの呼び出しは「CALL FUNCTION命令」を用います。
汎用モジュールを呼び出す際に必要なのは、呼び出す汎用モジュール名と、EXPORTING/IMPORTINGに渡してあげる情報のみ(テーブル)です。
IMPORTINGだけを利用する汎用モジュールであれば、もちろんEXPORTINGやTABLESを記述する必要はありません。
汎用モジュールの各種パラメータについて
①呼び出したい箇所にカーソルを合わせて、パターンボタンから呼び出しを行う
②自動で提案されるので、必要なパラメータを記載していく
【記載前】
【記載後】
◆動作確認
呼び出し元プログラム(汎用モジュール実行前)
それぞれ汎用モジュール内で処理された結果が反映されて呼び出し元プログラムに戻っている
仮に汎用モジュール内で例外:NOT_FOUNDが起こっていれば呼び出し元プログラムに帰ってきたときにSY-SUBRC = 1が設定されることになる。
例外の判定命令については、先述のとおりアドオンで汎用モジュールを作成する際はあまり考慮されない。
また、今回は汎用モジュール内でエラーハンドリングを行っていないために起こることはない。
処理内容
呼び出し元プログラム: ZR_FM_SAMPLE_KANDA_R
汎用モジュール:Z_M_GNELAL_MODULE_TEST_CP_Rの呼び出しのみ
汎用モジュール:Z_M_GNELAL_MODULE_TEST_CP_R
ZT200400101からのデータ取得(*なので全項目)
取得先はEX_TABLE(エクスポートパラメータ)
取得条件の登録日に20210101が設定されているので、以下の7件が取得される。
EX_NUMBERに数値「100」を代入する
数値100が入る
EX_TABLEの値をEX_DATAに代入する
EX_TABLEの値がEX_DATAに代入される
その後の処理は特にないので、結果画面等もなし。