【SAP ABAP】汎用モジュール（Function Module）の概要と作成方法

レイナ

汎用モジュールはどういうもので、どうやって作成したらいいんだろう？

SAPの汎用モジュール（Function Module）はABAPでコーディングされる共通機能です。

当記事では基本知識となる汎用モジュールの概要と汎用モジュールの作成方法について解説していきますね。
アドオン機能の設計や開発に関わるメンバーであれば必ず知っておくべき事項なので、もし知らない方は要チェックです！

汎用モジュールとは？

汎用モジュールとは、複数の異なるプログラムから呼び出して使用できる共通部品（関数）です。
複数の機能にて、同じロジックの処理をしたいという要件が発生することがあります。そんな時に汎用モジュールを利用します。

汎用モジュールの基本的な機能としては、大きく分けて以下の3つとなります。

• 呼び出し元プログラムからパラメータを受け取り
• 主処理
  トランザクションデータ登録・DB直接更新・ファイルアウトプットなどの何かしらの処理
• 呼び出し元プログラムへパラメータを受け渡し

例えば、複数の機能で「単価」と「個数」から「合計金額」を計算したいという要件があったとします。その場合は

• 呼び出し元のプログラムから「単価」と「個数」を受け取り
• 「単価」と「個数」を掛けて「合計金額」を算出
• 呼び出し元プログラムへ「合計金額」を受け渡し

という汎用モジュールを作成することで、複数の機能から汎用モジュールを呼び出すことで同じ計算結果を利用することができます。

共通部品（関数）としては、汎用モジュールだけではなくT-CODE：SE24でクラスを定義・作成することも可能です。クラスについては別途解説します！

汎用グループとは？

汎用グループとは一般的に、汎用モジュールを利用目的ごとに取りまとめるグループです。
汎用モジュールは必ず1つの汎用グループに紐付ける必要があります。
※1つの汎用モジュールには複数の汎用モジュールが紐付く構成となります。

汎用グループ内にある汎用モジュールは、変数や内部テーブルなどの定義を共通で利用することができます。

汎用モジュールの作成方法

汎用モジュールを作成する際はT-CODE：SE37を使用します。

汎用グループの登録

まずは汎用グループを登録します。
※既存の汎用グループに汎用モジュールを紐付ける場合は省略可能です。

T-CODE：SE37のヘッダメニューの「ジャンプ ＞ 汎用グループ ＞ グループ登録」を選択し、汎用グループIDと名称（内容説明）を入力して登録します。

汎用モジュールの登録

T-CODE：SE37から登録したい汎用モジュールIDを入力し、「登録」ボタンを押下します。

ポップアップ画面にて紐付ける汎用グループと汎用モジュールの説明文を入力します。

次にインポートパラメータ/エクスポートパラメータを入力します。※いずれも仕様により不要な場合もあります。
インポートパラメータの「任意」にチェックをいれるとプログラムから汎用モジュールを呼び出す際にパラメータの指定は必須ではなくなります。

インポート/エクスポートパラメータ以外にも以下のパラメータを指定することもできます。

• CHANGINGパラメータ
  呼び出し元のプログラムから渡された変数やテーブルを汎用モジュール内で編集し、呼び出し元のプログラムに返します。
• テーブルパラメータ
  呼び出し元のプログラムから渡されたテーブルを汎用モジュール内で編集し、呼び出し元のプログラムに返します。
• 例外パラメータ
  汎用モジュール内で意図しない処理がされた場合などに例外を返します。
  例外が返された際には、呼び出し元プログラム上ではシステム変数：SY-SUBRCに例外番号が設定されます。

以下では例外パラメータで個数（kosu）が0だった場合は「KOSU_ERROR」という例外を出力する例となります。

次に、ソースコードタブにて処理したい内容をABAPで記述します。

以下の例では個数（kosu）が0だった場合は例外を返し、0以外だった場合は合計金額（goukei_kingaku）に単価（tanka）×個数（kosu）を設定する内容を記述しています。

以下は上図のプログラム部分をテキストで記載したものです。

FUNCTION ztest_satofn01. " 作成した汎用モジュール名
*"----------------------------------------------------------------------
*"*"ローカルインタフェース:
*"  IMPORTING
*"     REFERENCE(TANKA) TYPE  PRICE
*"     REFERENCE(KOSU) TYPE  AMNT
*"  EXPORTING
*"     REFERENCE(GOUKEI_KINGAKU) TYPE  TOTAL_KK
*"  EXCEPTIONS
*"      KOSU_ERROR
*"----------------------------------------------------------------------

* 個数が0の場合は例外を返す
  IF kosu = 0.
    RAISE kosu_error.
  ENDIF.

* 合計金額を計算する
  goukei_kingaku = tanka * kosu.

ENDFUNCTION.

構文チェックしてエラーが無ければ有効化をしてみましょう！
その際に汎用グループを登録した際に自動で登録されるプログラムも一緒に選択して有効化しましょう。

汎用モジュールの単体テスト

先ほど作った汎用モジュールをテストしてみましょう。
T-CODE：SE37から作成した汎用モジュールを指定し実行ボタンを押下します。

次にインポートパラメータを指定し実行します。

以下は個数（kosu）に0を入れて例外が返される確認です。

次に個数（kosu）に0以外を入れて合計金額（goukei_kingaku）が計算されるかの確認です。

汎用モジュールをプログラムから呼び出す

プログラムから汎用モジュールを呼び出す方法も解説をします。
ここではT-CODE：SE38から呼び出し方を見てみましょう。

パターンボタンを押下し、CALL FUNCTIONにて先ほど作成した汎用モジュールを入力してENTERを押下してみましょう。

するとプログラム内に汎用モジュールと定義されたパラメータが記述されたソースコードのフォーマットが自動入力されます。

以下は上記のフォーマットを編集し、単価（tanka）が100・個数（kosu）が9を汎用モジュールに渡して合計金額（goukei_kingaku）を出力する例です。

以下は上図のプログラム部分をテキストで記載したものです。

REPORT ztest_sato18. " 作成したプログラム名

* 変数定義
DATA
  g_goukei_kingaku TYPE total_kk. "合計金額

* 汎用モジュール
CALL FUNCTION 'ZTEST_SATOFN01' " 作成した汎用モジュール名
  EXPORTING
    tanka          = 100
    kosu           = 9
  IMPORTING
    goukei_kingaku = g_goukei_kingaku
  EXCEPTIONS
    kosu_error     = 1
    OTHERS         = 2.

* 例外処理
IF sy-subrc <> 0.
* Implement suitable error handling here
ENDIF.

* 合計金額出力
write g_goukei_kingaku.

上記プログラムを実行すると、合計金額（goukei_kingaku）が900と正しく計算され出力されることが確認できます。

さいごに

汎用モジュールは複数の機能で共通化した処理として使えるよう、設計者同士で認識の齟齬がないようにする必要があります。
正常系の処理だけではなく、異常系の処理への対処方法も認識合わせることが重要になります。

博士

汎用モジュールの概要と作成方法についての解説は以上じゃ！