アプリケーションサーバー上のファイルを扱うABAPで、ディレクトリをソースコードに固定すると、環境やOSが変わるたびに修正が必要になります。FILE_GET_NAMEは、トランザクションFILEなどで定義した論理ファイル名から、その環境で使う物理ファイル名を取得する汎用モジュールです。
名前から「パスだけを返す」と思われがちですが、通常はディレクトリとファイル名を含む物理ファイル名を返します。論理ファイル名・論理パス・物理パスの役割を先に整理してから使いましょう。
FILE_GET_NAMEの前提:トランザクションFILEの設定
| 設定 | 役割 | 例(説明用) |
|---|---|---|
| 論理ファイル名 | ABAPから指定する名前。ファイル形式や論理パスと結び付ける | Z_IF_OUT_FILE |
| 物理ファイル名 | 固定名または<PARAM_1>などを含む名前 | orders_<PARAM_1>.csv |
| 論理パス | OSの構文グループごとに物理パスを持つ | Z_IF_OUT_PATH |
| 物理パス | <FILENAME>を配置するサーバー上のパス | /sap/interface/out/<FILENAME> |
上記は設定の考え方を示す例です。実際の定義と出力先は自社システムのFILEで確認します。クライアント依存の論理ファイル名を使う構成ではSF01での定義も確認してください。
ABAPで物理ファイル名を取得する例
DATA: lv_file_name TYPE string,
lv_emergency_flag TYPE c LENGTH 1.
CALL FUNCTION 'FILE_GET_NAME'
EXPORTING
logical_filename = 'Z_IF_OUT_FILE'
parameter_1 = sy-datum
IMPORTING
file_name = lv_file_name
emergency_flag = lv_emergency_flag
EXCEPTIONS
file_not_found = 1
OTHERS = 2.
IF sy-subrc <> 0 OR lv_emergency_flag IS NOT INITIAL.
" 論理ファイルの定義・OS別パスを確認し、ここで処理を止める
RETURN.
ENDIF.
" lv_file_name は後続の OPEN DATASET などで使用する
PARAMETER_1は、定義に<PARAM_1>を使っている場合の置換値です。定義がなければ不要です。FILE_NAMEには設定に従った物理ファイル名が返ります。FILE_NOT_FOUNDだけでなくEMERGENCY_FLAGも確認してください。OSに対応するパスを解決できない場合、代替パスが返ることがあり、意図しない場所への出力を防ぐためです。
ディレクトリだけを取得したい場合
論理ファイル名をデータ形式DIRで定義している場合は、INCLUDING_DIR = abap_trueを指定して呼び出します。この場合の結果はディレクトリの物理パスです。通常のファイル名取得とは分けて考えてください。INCLUDING_DIRを指定した場合、WITH_FILE_EXTENSIONの扱いも通常とは異なります。
運用時の確認点
- 取得できたパスはSAPアプリケーションサーバー側のパスです。SAP GUIを動かすPCのフォルダではありません。
- ファイルを実際に開けるかどうかは別です。ディレクトリの存在、OS・SAP側の権限、
OPEN DATASETの結果を確認します。 - ユーザー入力の物理ファイル名を使う設計では、許可された論理ファイルの範囲から外れないか
FILE_VALIDATE_NAMEなどで検証します。
ファイル名を実行時に決め、論理パスと組み合わせたい場合は、FILE_GET_NAME_USING_PATHの使い方を参照してください。
参考・関連記事
- FILE_GET_NAME_USING_PATH:論理パスと任意のファイル名から完全ファイル名を作る
- TRINT_SPLIT_FILE_AND_PATH:取得済みフルパスをディレクトリとファイル名に分ける
- 汎用モジュール一覧:ABAPの関連機能を探す