時間のかかるABAPレポートをSAP GUIで実行すると、画面が変わらない間、利用者は処理が進んでいるか判断しにくくなります。SAPGUI_PROGRESS_INDICATORを使うと、処理状況を示すテキストと進捗率をSAP GUIに表示できます。本記事では呼び出し方と、ループ処理で表示する際の注意点を説明します。
汎用モジュール名と表示できる内容
汎用モジュール名はSAPGUI_PROGRESS_INDICATORです。旧記事の「SAP_GUI_PROGRESS_INDICATOR」は誤記のため修正しました。SE37で検索するときも、SAPGUIを続けて入力してください。
PERCENTAGEには0~100の進捗率、TEXTには現在の処理内容を渡します。割合は汎用モジュールが自動計算するわけではなく、プログラム側で求めます。単純な件数ベースの割合は、各件の所要時間が大きく異なる処理では残り時間の目安にならない点にも注意してください。
基本的な呼び出し方
CALL FUNCTION 'SAPGUI_PROGRESS_INDICATOR'
EXPORTING
percentage = 25
text = 'データを処理しています'.
上の例は25%を表示します。画面上の表示はSAP GUIの種類やバージョンで異なります。まず対象システムのSE37でインターフェースを確認し、前景実行で表示を試してください。
LOOPで進捗率を更新する例
処理対象の内部テーブルlt_itemsがある場合の例です。0件のときのゼロ除算を避け、進捗率が約5ポイント進むごとと最終件だけ表示します。実際の処理をコメント部分に入れてください。
DATA: lv_total TYPE i,
lv_done TYPE i,
lv_percent TYPE i,
lv_last_percent TYPE i.
lv_total = lines( lt_items ).
lv_last_percent = -5.
IF lv_total > 0.
LOOP AT lt_items ASSIGNING FIELD-SYMBOL(<ls_item>).
" ここで1件分の処理を行う
lv_done = lv_done + 1.
lv_percent = ( lv_done * 100 ) DIV lv_total.
IF sy-batch IS INITIAL AND
( lv_percent >= lv_last_percent + 5 OR
lv_done = lv_total ).
CALL FUNCTION 'SAPGUI_PROGRESS_INDICATOR'
EXPORTING
percentage = lv_percent
text = 'データを処理しています'.
lv_last_percent = lv_percent.
ENDIF.
ENDLOOP.
ENDIF.
lt_itemsの宣言・取得処理は省略しています。lv_doneを独立したカウンタにしているため、ループ内で別のテーブルを読む処理があってもsy-tabixの変化に左右されません。構文は利用中のABAPリリースに合わせて調整してください。
表示するときの注意点
- 毎件呼び出さない:GUIへの更新を大量に行うと処理時間が増えます。件数や経過時間を基準に、必要な頻度だけ更新します。
- バックグラウンドでは画面表示に頼らない:
sy-batchを確認して前景実行時のみ呼び出します。ジョブの経過や結果はSM37のジョブログなどで確認できる設計にします。 - 実際の処理に合う割合を示す:複数工程がある処理や対象件数を事前に求められない処理では、件数だけから作った百分率が誤解を招く場合があります。そのときは工程名や処理中の対象を示す方法を検討します。
システムのリリースで利用できるなら、進捗表示用クラスCL_PROGRESS_INDICATORも選択肢です。呼び出し頻度の制御などを含むため、既存標準の実装とSE24のインターフェースを確認して採用を判断してください。
まとめ
SAPGUI_PROGRESS_INDICATORは、前景で実行するABAP処理の進み具合を利用者に伝える手段です。処理件数が0のケースを考慮して割合を計算し、表示の更新回数を抑えて使いましょう。表示自体は処理速度を上げるものではないため、時間がかかる原因の調査や処理改善も必要に応じて行ってください。
参考・関連記事
- ABAPで使う汎用モジュール一覧:日付・数値など、ほかの便利な汎用モジュールを探せます。
- LOOPの中で使う変数・構造はCLEAR漏れを要チェック:ループ処理で起きやすい不具合を確認できます。
- プログラムをバックグラウンド実行する方法:長時間の処理をジョブで実行するときの基本を確認できます。