FILE_GET_NAME SAP Function module - Assign the Physical File Name Using a Logical File Name

Pattern for FM FILE_GET_NAME - FILE GET NAME

Associated Function Group: SFIL
Released Date: 05.09.1996

CALL FUNCTION 'FILE_GET_NAME' "Assign the Physical File Name Using a Logical File Name
  EXPORTING
*   client = SY-MANDT           " sy-mandt      Client for reading the file name t
*   client = SY-MANDT           " sy-mandt      Client for reading the file name table
    logical_filename =          " filename-fileintern  Logical file name
*   operating_system = SY-OPSYS  " sy-opsys     Operating system
*   parameter_1 = SPACE         "               Parameter for variable 
*   parameter_1 = SPACE         "               Parameter for variable 
*   parameter_2 = SPACE         "               Parameter for variable 
*   parameter_2 = SPACE         "               Parameter for variable 
*   parameter_3 = SPACE         "               Parameter for variable 
*   use_presentation_server = SPACE  "          Use SAPtemu operating system
*   with_file_extension = SPACE  "              Append file format to file names
*   use_buffer = SPACE          "               Buffering flag
*   eleminate_blanks = 'X'      " sy-datar      Eliminate blank characters = 'X'
  IMPORTING
    emergency_flag =            "               Fall-back operation required flag
    file_format =               " filename-fileformat  Format of the file
    file_format =               " filename-fileformat  File format
    file_name =                 "               Physical file name
    file_name =                 "               Physical file name
  EXCEPTIONS
    FILE_NOT_FOUND = 1          "               Logical file name is unknown
    .  "  FILE_GET_NAME

SAP Documentation for FM FILE_GET_NAME

FUNCTIONALITY

R/3 applications run on various platforms with various file systems. This function module enables you to use platform-independent logical file names in your application programs.
Based on definitions maintained in customizing tables for platform-independent file names, the function module converts a logical file name to the corresponding physical file name and path for the hardware platform concerned.

For this conversion to work for different platforms, the definition of
a logical file name must include a logical file path, which in turn is

converted to different physical file paths, depending on the particular platform. The platform-specific file name returned by the function module is composed of the physical file path for the current platform and the physical file name associated with the logical file name. Placeholders in physical file and path names are substituted at runtime by the corresponding current values.

EXAMPLE

logical file name:,,MONTHLY_SALES_FILE
physical file name:,,VALUES
logical path:,,SALES_DATA_PATH
physical path (UNIX):,,/usr//
physical path (Windows):,,C:\SALES\

Example 1

Get file name for UNIX platform
(current system: K11)

CALL FUNCTION 'FILE_GET_NAME'

EXPORTING
LOGICAL_FILENAME = 'MONTHLY_SALES_FILE'
IMPORTING
FILE_NAME = FILE
FILE_FORMAT = FORMAT.

Result:

FILE = /usr/K11/VALUES

FORMAT = WK1

Example 2

Get file name for UNIX platform, passing a parameter
(current system: K11)

CALL FUNCTION 'FILE_GET_NAME'

EXPORTING
LOGICAL_FILENAME = 'MONTHLY_SALES_FILE'
PARAMETER_1 = '_TST'
IMPORTING
FILE_NAME = FILE
FILE_FORMAT = FORMAT.

Result:

FILE = /usr/K11/VALUES_TST

FORMAT = WK1

Example 3

Get file name for WINDOWS platform, with file name extension

CALL FUNCTION 'FILE_GET_NAME'

EXPORTING
LOGICAL_FILENAME = 'MONTHLY_SALES_FILE'
WITH_FILE_EXTENSION = 'X'
IMPORTING
FILE_NAME = FILE
FILE_FORMAT = FORMAT.

Result:

FILE = C:\SALES\VALUES.WK1

FORMAT = WK1

HINTS
All definitions needed for the platform-independent assignment of file names are maintained client-independently with transaction FILE. Logical file names (but not logical file paths) can also be defined specifically for the current client with transaction SF01. Transaction SF07 generates a list of current definitions.
The following concepts are used in the platform-independent assignment of file names:

Logical file name

A descriptive name for a file which is associated with these values:

physical file name

file format

logical file path.

If no logical file path is specified, the function module returns the physical file name only; placeholders are substituted by current values.

Physical file name

The physical file name may contain placeholders.

Logical file path

A descriptive name for a path which is associated with these values:

syntax groups (groups of operating systems)

physical file paths.

Physical file path

The physical file path is defined for a particular syntax group. It
must contain the reserved word  as a placeholder for the file

name. It may also contain other placeholders.

Operating system

Presentation server and application server can run under different
operating systems. The current value for the application server can be

obtained from the system field SY-OPSYS, the value for the presentation server by calling function module WS_QUERY.
Both operating systems must be defined and assigned to a syntax group.

Syntax group

Group of operating systems with a common syntax for file and path names
(e.g. HP-UX and SINIX).

Placeholder

Reserved words, set in angle brackets, which can be included in
physical file and path names (e.g. , ). You can find

information on possible reserved words in the online help (F1 help) for the fields physical file name and physical file path when maintaining platform-independent file names with transaction FILE.
If the logical path associated with a logical file name does not specify a physical path for the current operating system (syntax group), the path stored in the profile parameter DIR_GLOBAL of the current system is used for generating a complete platform-specific file name.

Documentation extract taken from SAP system, Copyright (c) SAP AG

FILENAME_GET

FILE_GET_NAME_AND_LOGICAL_PATH

Share |