00

25/09/03

15:11

Page ix

Contents
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ix

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Layout of Reference Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
An Introduction to SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Using Function Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxvii
1. System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ABAP4_CALL_TRANSACTION Initiates a transaction in a separate window . . . . . . . . . . . .
ARFC_GET_TID Returns IP address of the server (in hexadecimal) . . . . . . . . . . . . . . . . . .
AUTHORITY_CHECK_DATASET Checks file access authorization . . . . . . . . . . . . . . . . . . . . . . .
BP_ EVENT_RAISE Triggers background event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CAT_CHECK_RFC_DESTINATION Checks the RFC destinations and connections . . . . . . . .
CAT_PING Checks RFC system and configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DEQUEUE_ES_PROG Releases program locks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ENQUEUE_ES_PROG Prevents parallel execution of program . . . . . . . . . . . . . . . . . . . . . . .
FTP_COMMAND Executes a command on the FTP server . . . . . . . . . . . . . . . . . . . . . . . . . .
FTP_CONNECT Opens connection to the FTP server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FTP_DISCONNECT Closes connection to the FTP server . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET_JOB_RUNTIME_INFO Retrieves detailed job information . . . . . . . . . . . . . . . . . . . . . . . .
GUI_EXEC Starts an external program asynchronously . . . . . . . . . . . . . . . . . . . . . . . . . . .
GUI_GET_DESKTOP_INFO Returns information about the end-users desktop . . . . . . . . .
GUI_RUN Starts program with ShellExecute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GWY_READ_CONNECTIONS Checks gateway connection . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HLP_MODE_CREATE Creates another session in system . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IW_C_GET_FRONTEND_VERSION Version of SAP front-end installed on a PC . . . . . . . . . . .
RFC_MAIL Sends e-mail to another SAP system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSPO_FIND_SPOOL_REQUESTS Finds a spool number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSPO_OUTPUT_SPOOL_REQUEST Outputs same request on a different printer . . . . . . . . .
RSPO_RPRINT_SPOOLREQ Triggers spool to print automatically . . . . . . . . . . . . . . . . . . . . . .
SAPWL_GET_SUMMARY_STATISTIC Summary of object usage statistics . . . . . . . . . . . . . . . .
SAPWL_WORKLOAD_GET_DIRECTORY Timeframe of statistics on SAP database . . . . . . . . . . .
SAPWL_WORKLOAD_GET_STATISTIC Object usage statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW_JOBSTATE Checks the status of a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SO_SPOOL_READ Returns printer spool information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ix

1
1
2
3
5
6
7
8
8
9
10
12
13
13
14
16
17
18
19
20
20
22
23
23
25
26
27
29

00

25/09/03

15:11

Page x

Contents
SO_WIND_SPOOL_LIST Dialogue to browse printer spool numbers . . . . . . . . . . . . . . . . . .
SXPG_CALL_SYSTEM Calls command external to the SAP system . . . . . . . . . . . . . . . . . . . .
SXPG_COMMAND_CHECK Checks authorization to execute a command . . . . . . . . . . . . . .
SXPG_COMMAND_EXECUTE Executes a command on remote system . . . . . . . . . . . . . . . . .
SXPG_COMMAND_LIST_GET Reads a list of external OS commands . . . . . . . . . . . . . . . . . . .
TERMINAL_ID_GET Returns IP address and the terminal ID . . . . . . . . . . . . . . . . . . . . . . . . . .
TH_DELETE_USER Logs off a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TH_ENVIRONMENT Gets values in SAP environment variables . . . . . . . . . . . . . . . . . . . . . . .
TH_REMOTE_TRANSACTION Runs a transaction on a remote server . . . . . . . . . . . . . . . . . . .
TH_SERVER_LIST List of RFC servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TH_USER_INFO Returns information about user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TH_USER_LIST Displays users logged onto server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSACTION_CALL Initiates a transaction in a separate window . . . . . . . . . . . . . . . . . . .
USER_EXISTS Checks whether user ID is valid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WS_EXECUTE Calls another program from ABAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WS_QUERY Executes query function on front-end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

30
31
33
34
35
35
36
37
38
39
39
41
42
42
43
44

2. Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
BAPI_CURRENCY_CONV_TO_EXTERNAL Converts currency format to external format . . . .
BAPI_CURRENCY_CONV_TO_INTERNAL Converts currency format to internal format . . . . .
CF_UT_UNIT_CONVERSION Converts material unit quantities . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERSION_EXIT_ALPHA_INPUT Converts number to a string filled with zeroes . . . . . . .
CONVERSION_EXIT_ALPHA_OUTPUT Converts number with zeroes into an integer . . . . . .
CONVERSION_EXIT_AUART_INPUT Converts sales document type to SAP format . . . . . . .
CONVERSION_EXIT_AUART_OUTPUT Converts sales document type to display format . . .
CONVERSION_EXIT_CUNIT_INPUT Converts external unit to SAPs internal unit . . . . . . . . .
CONVERSION_EXIT_CUNIT_OUTPUT Converts internal unit to commercial unit . . . . . . . . . .
CONVERSION_EXIT_LUNIT_INPUT Converts technical unit for internal unit . . . . . . . . . . . . . .
CONVERSION_EXIT_LUNIT_OUTPUT Converts internal unit to technical unit . . . . . . . . . . . . .
CONVERSION_FACTOR_GET Returns conversion factors for a unit . . . . . . . . . . . . . . . . . . . . .
CONVERT_ABAPSPOOLJOB_2_PDF Converts ABAP spool output to PDF . . . . . . . . . . . . . . . .
CONVERT_OTFSPOOLJOB_2_PDF Converts an OTF (SAPscript) spool to PDF . . . . . . . . . . . .
CONVERT_TO_FOREIGN_CURRENCY Converts local currency to foreign currency . . . . . . . .
CONVERT_TO_LOCAL_CURRENCY Converts foreign currency to local currency . . . . . . . . . .
CURRENCY_AMOUNT_SAP_TO_IDOC Converts currency to IDOC format . . . . . . . . . . . . . . . .
CURRENCY_CODE_ISO_TO_SAP ISO currency code to SAPs currency code . . . . . . . . . . . . .
CURRENCY_CODE_SAP_TO_ISO SAP currency code to ISO currency code . . . . . . . . . . . . . .
DATE_STRING_CONVERT Converts string date into DATE type . . . . . . . . . . . . . . . . . . . . . . . .
DIMENSION_CHECK Checks internal unit of dimension . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DIMENSION_GET Retrieves internal ID of specified dimension . . . . . . . . . . . . . . . . . . . . . .
DIMENSION_GET_FOR_UNIT Textual description of dimension . . . . . . . . . . . . . . . . . . . . . . . .
HR_ROUND_NUMBER Rounds a number according to rules . . . . . . . . . . . . . . . . . . . . . . . . .
HRCM_AMOUNT_TO_STRING_CONVERT Converts an amount to a character string . . . . . . .
HRCM_STRING_TO_AMOUNT_CONVERT Converts a character string to an amount . . . . . . .
MATERIAL_UNIT_CONVERSION Converts base unit to alternative unit . . . . . . . . . . . . . . . . .
MD_CONVERT_MATERIAL_UNIT Conversion of material units . . . . . . . . . . . . . . . . . . . . . . . . .
ROUND Rounds value to a number of decimal places . . . . . . . . . . . . . . . . . . . . . . . . . . .

47
48
49
50
51
51
52
53
54
55
56
57
59
61
63
64
66
67
68
68
69
71
71
72
73
74
75
76
77

00

25/09/03

15:11

Page xi

Contents
ROUND_AMOUNT Rounding based on company and currency . . . . . . . . . . . . . . . . . . . .
SI_UNIT_GET Retrieves international unit of measure . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SX_OBJECT_CONVERT_OTF_PDF Conversion from OTF (SAPscript) to PDF . . . . . . . . . . . . .
SX_OBJECT_CONVERT_OTF_PRT Conversion from OTF to printer format . . . . . . . . . . . . . .
SX_OBJECT_CONVERT_OTF_RAW Conversion from OTF (SAPscript) to ASCII . . . . . . . . . . .
UNIT_CONVERSION_SIMPLE Converts measurement unit values and rounds . . . . . . . . .
UNIT_CONVERSION_WITH_FACTOR Converts value according to the factor passed . . . . .
UNIT_CORRESPONDENCE_CHECK Checks if units belong to same dimension . . . . . . . . . .
UNIT_GET Returns unit for dimension and factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UNIT_OF_MEASURE_ISO_TO_SAP Converts ISO unit to SAP unit of measure . . . . . . . . . . .
UNIT_OF_MEASURE_SAP_TO_ISO Converts SAP unit to ISO unit of measure . . . . . . . . . . .
UNIT_OF_MEASUREMENT_HELP Displays all units of a specified dimension . . . . . . . . . . .

xi
79
80
81
84
84
85
86
87
88
90
91
92

3. Dates and Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

ADD_TIME_TO_DATE Adds months/days/years to a date . . . . . . . . . . . . . . . . . . . . . . . . . . .
C14B_ADD_TIME Adds a time value to a date and time . . . . . . . . . . . . . . . . . . . . . . . . . . .
COMPUTE_YEARS_BETWEEN_DATES Number of years between two dates . . . . . . . . . . . . .
CONVERSION_EXIT_LDATE_OUTPUT Converts date format . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERT_DATE_INPUT Conversion exit routine for inverted date . . . . . . . . . . . . . . . . . . .
CONVERT_DATE_TO_EXTERNAL Formats date from internal to display format . . . . . . . .
CONVERT_DATE_TO_INTERNAL Formats date from display to internal format . . . . . . . . .
COPF_DETERMINE_DURATION Calculates difference between date and time . . . . . . . . .
DATE_CHECK_PLAUSIBILITY Checks if the value of a field is a date format . . . . . . . . . . . .
DATE_CHECK_WORKINGDAY Determines if a single date is a working day . . . . . . . . . . . .
DATE_CHECK_WORKINGDAY_MULIPLE Checks date across multiple factory calendars . .
DATE_COMPUTE_DAY Determines the day of the week for a date . . . . . . . . . . . . . . . . . .
DATE_CONV_EXT_TO_INT Conversion of dates to SAPs internal format . . . . . . . . . . . . . .
DATE_CONVERT_TO_FACTORYDATE Converts calendar date into factory day . . . . . . . . . . .
DATE_CONVERT_TO_WORKINGDAY Converts a calendar date into working day . . . . . . . .
DATE_CREATE Calculates a date from the input parameters . . . . . . . . . . . . . . . . . . . . . .
DATE_GET_WEEK Determines the week in a year for a date . . . . . . . . . . . . . . . . . . . . . . . .
DATE_IN_FUTURE Calculates a future or past date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DATE_TO_PERIOD_CONVERT Returns the period of a date . . . . . . . . . . . . . . . . . . . . . . . . . . .
DATUMSAUFBEREITUNG Formats date as per the user settings . . . . . . . . . . . . . . . . . . . . . .
DAY_ATTRIBUTES_GET Returns information about a day . . . . . . . . . . . . . . . . . . . . . . . . . . .
DAY_IN_WEEK Returns the day of the week for a date . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DAYS_BETWEEN_TWO_DATES Calculates number of days between two dates . . . . . . . .
EASTER_GET_DATE The date of Easter Sunday . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FACTORYDATE_CONVERT_TO_DATE Converts factory day into calendar date . . . . . . . . . . .
FIMA_DAYS_AND_MONTHS_AND_YEARS Calculates the difference between two dates .
FIRST_AND_LAST_DAY_IN_YEAR_GET First and last days of a period . . . . . . . . . . . . . . . . . . .
FIRST_DAY_IN_PERIOD_GET Gets first day of a period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GET_CURRENT_YEAR Gets the current fiscal year for a company . . . . . . . . . . . . . . . . . . . .
HOLIDAY_CHECK_AND_GET_INFO Determines if a date is a holiday . . . . . . . . . . . . . . . . . . .
HOLIDAY_GET All holidays in a factory calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HR_BEN_GET_DATE_INTERSECTION Checks if dates overlap another date range . . . . . . .
HR_GET_LEAVE_DATA Gets all leave information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93
95
95
96
97
98
99
100
101
102
103
105
106
107
109
110
110
112
113
115
116
117
118
118
119
120
121
122
122
123
124
126
128

00

25/09/03

xii

15:11

Page xii

Contents
HR_HK_DIFF_BT_2_DATES Days, months and years between two dates . . . . . . . . . . . . . .
HR_IE_NUM_PRSI_WEEKS Number of weeks between two dates . . . . . . . . . . . . . . . . . . . .
HR_PAYROLL_PERIODS_GET Gets the payroll period for a particular date . . . . . . . . . . . . .
HR_TIME_RESULTS_GET Gets the time results for a payroll period . . . . . . . . . . . . . . . . . . .
LAST_DAY_IN_PERIOD_GET Gets last day of a period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MONTH_NAMES_GET Names of all the months . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MONTH_PLUS_DETERMINE Adds or subtracts months to/from a date . . . . . . . . . . . . . . . .
PERIOD_DAY_DETERMINE Starts and finishes date for period-fiscal year . . . . . . . . . . . . .
RE_ADD_MONTH_TO_DATE Adds or subtracts months to/from a date . . . . . . . . . . . . . . .
RH_GET_DATE_DAYNAME Returns the day based on the date provided . . . . . . . . . . . . .
RKE_ADD_TO_PERIOD Calculates period from any period . . . . . . . . . . . . . . . . . . . . . . . . . .
RKE_TIMESTAMP_CONVERT_INPUT Converts display to TIMESTAMP fields . . . . . . . . . . . . .
RKE_TIMESTAMP_CONVERT_OUTPUT Converts TIMESTAMP fields for display . . . . . . . . . . .
RP_CALC_DATE_IN_INTERVAL Adds/subtracts years, months, days to/from date . . . . . .
RP_CHECK_DATE Checks if value is in date format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RP_LAST_DAY_OF_MONTHS Gets the last day of the month . . . . . . . . . . . . . . . . . . . . . . . . .
SD_DATETIME_DIFFERENCE Difference in days and time for two dates . . . . . . . . . . . . . . .
SUBTRACT_TIME_FROM_DATE Subtracts months, days, and years from a given date . .
SWI_DURATION_DETERMINE The time between two events in seconds . . . . . . . . . . . . . .
WDKAL_DATE_ADD_FKDAYS Number of working days in a date range . . . . . . . . . . . . . . .
WEEK_GET_FIRST_DAY Returns the date of the Monday of a week . . . . . . . . . . . . . . . . . .
WEEK_GET_NR_OF_WORKDAYS The number of workable days in a week . . . . . . . . . . . . .
WEEKDAY_GET Names of all the days of the week . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

130
131
132
134
135
135
137
137
138
139
139
140
141
142
142
143
144
145
146
147
148
149
150

4. Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
C13Z_FILE_DOWNLOAD_ASCII Downloads a file in ASCII format . . . . . . . . . . . . . . . . . . . . . .
C13Z_FILE_DOWNLOAD_BINARY Downloads a file in binary format . . . . . . . . . . . . . . . . . . .
C13Z_FILE_UPLOAD_ASCII Uploads a file in ASCII format . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C13Z_FILE_UPLOAD_BINARY Uploads a file in binary format . . . . . . . . . . . . . . . . . . . . . . . . .
DOWNLOAD Downloads a file to the PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EPS_GET_DIRECTORY_LISTING Lists filenames from the application server . . . . . . . . . . . .
EPS_GET_FILE_ATTRIBUTES Returns attributes for a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GUI_CREATE_DIRECTORY Creates a directory on the presentation server . . . . . . . . . . . .
GUI_DELETE_FILE Deletes a file on the presentation server . . . . . . . . . . . . . . . . . . . . . . . .
GUI_DOWNLOAD Downloads a file to the presentation server . . . . . . . . . . . . . . . . . . . . .
GUI_REMOVE_DIRECTORY Deletes a directory in the presentation server . . . . . . . . . . . .
GUI_UPLOAD Uploads a file from the presentation server . . . . . . . . . . . . . . . . . . . . . . . .
LIST_DOWNLOAD Downloads report to local file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PROFILE_GET Reads an entry in an INI file on the frontend . . . . . . . . . . . . . . . . . . . . . . .
PROFILE_SET Writes an entry to an INI file on the frontend . . . . . . . . . . . . . . . . . . . . . . .
RS_DELETE_PROGRAM Deletes an ABAP program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RSPO_DOWNLOAD_SPOOLJOB Downloads program spool to a file . . . . . . . . . . . . . . . . . . .
RZL_READ_DIR Reads a directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RZL_READ_FILE Reads a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RZL_WRITE_FILE_LOCAL Saves internal table to the presentation server . . . . . . . . . . . . .
SO_SPLIT_FILE_AND_PATH Splits a path into a filename and a path . . . . . . . . . . . . . . . . . .

151
155
156
157
157
160
161
162
164
165
166
166
167
168
169
170
171
172
173
174
175

00

25/09/03

15:11

Page xiii

Contents
STRR_GET_REPORT Downloads ABAP source code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRUCTURE_EXPORT_TO_MSACCESS Downloads data into MS Access . . . . . . . . . . . . . . . . .
TABLE_EXPORT_TO_MSACCESS Downloads data into MS Access . . . . . . . . . . . . . . . . . . . . .
TMP_GUI_DIRECTORY_LIST_FILES Lists files and subdirectories . . . . . . . . . . . . . . . . . . . . . . .
TMP_GUI_READ_DIRECTORY Lists files in a directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UPLOAD Uploads a file into SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UPLOAD_FILES Uploads multiple files into SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WS_DOWNLOAD File transfer from internal table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WS_FILE_DELETE Deletes file in the presentation server . . . . . . . . . . . . . . . . . . . . . . . . . . .
WS_FILENAME_GET Calls file selector popup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WS_UPLOAD File transfer to internal table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

xiii
175
176
178
179
180
181
182
183
184
184
185

5. Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
DYNP_VALUES_READ Reads screen values before PAI transport . . . . . . . . . . . . . . . . . . . .
DYNP_VALUES_UPDATE Changes screen field contents without PBO . . . . . . . . . . . . . . . .
F4IF_INT_TABLE_VALUE_REQUEST Standard help at process on value-request . . . . . . . . .
HR_DISPLAY_BASIC_LIST Provides a table control for data . . . . . . . . . . . . . . . . . . . . . . . . . .
K_ABC_DOKU_SHOW Reads documentation from local program . . . . . . . . . . . . . . . . . . .
LIST_FROM_MEMORY Retrieves the output of report from memory . . . . . . . . . . . . . . . .
LIST_TO_ASCI Converts an ABAP report to ASCII . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RPY_DYNPRO_READ Reads screen objects, including screen flow . . . . . . . . . . . . . . . . . .
RS_COVERPAGE_SELECTIONS Returns the selection parameters for a report . . . . . . . . . .
RS_CREATE_VARIANT For creating dynamic variants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS_REFRESH_FROM_SELECTOPTIONS Returns the selection parameters for a report . . . .
RS_SET_SELSCREEN_STATUS Deactivates function codes on screen . . . . . . . . . . . . . . . . . .
RS_TOOL_ACCESS Reads documentation from another program . . . . . . . . . . . . . . . . . .
RS_VARIANT_CONTENTS Values of a variant returned in a table . . . . . . . . . . . . . . . . . . . . .
RS_VARIANT_DELETE Deletes a variant from a program . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS_VARIANT_EXISTS Checks whether a variant exists for a report . . . . . . . . . . . . . . . . . .
RS_VARIANT_TEXT Returns short description of variant . . . . . . . . . . . . . . . . . . . . . . . . . . .
RS_VARIANT_VALUES_TECH_DATA Reads variant parameters of a report . . . . . . . . . . . . . .
RZL_SUBMIT Submits a remote report for execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAPGUI_PROGRESS_INDICATOR Displays a progress bar on the SAP GUI . . . . . . . . . . . . . .
SAVE_LIST Saves report as list container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VRM_SET_VALUES Customises values on a drop-down field . . . . . . . . . . . . . . . . . . . . . . .
WRITE_LIST Contents from LIST_FROM_MEMORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WWW_ITAB_TO_HTML Converts internal table to HTML format . . . . . . . . . . . . . . . . . . . . .
WWW_LIST_TO_HTML Converts report list to HTML format . . . . . . . . . . . . . . . . . . . . . . . . .

189
193
193
194
195
196
197
198
199
200
202
203
204
206
206
207
207
208
209
209
210
211
212
213
214

6. Long Texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

COMMIT_TEXT Moves long texts from memory into log file . . . . . . . . . . . . . . . . . . . . . . .
CREATE_TEXT Creates header long text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DELETE_TEXT Deletes long text(s) from SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EDIT_TEXT Edits long text in fullscreen text editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
INIT_TEXT Initialises long text header and line table . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PRINT_TEXT Formats text for printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PRINT_TEXT_ITF Formats text into ITF for printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

217
218
220
221
222
222
223

00

25/09/03

xiv

15:11

Page xiv

Contents
READ_TEXT Reads text module into SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAVE_TEXT Saves long text in SAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

224
224

7. Number Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

NUMBER_GET_NEXT Obtains next number from number object . . . . . . . . . . . . . . . . . . .
NUMBER_RANGE_DEQUEUE Unlocks the number range object . . . . . . . . . . . . . . . . . . . . . .
NUMBER_RANGE_ENQUEUE Locks the number range object . . . . . . . . . . . . . . . . . . . . . . . .
NUMBER_RANGE_INTERVAL_LIST Gets existing intervals of a number object . . . . . . . . . .
NUMBER_RANGE_OBJECT_CLOSE Writes all changes to the database . . . . . . . . . . . . . . . . .
NUMBER_RANGE_OBJECT_DELETE Deletes the definition of a number object . . . . . . . . .
NUMBER_RANGE_OBJECT_GET_INFO Gets information for a number range object . . . . .
NUMBER_RANGE_OBJECT_INIT Initialises local memory for a number object . . . . . . . . .
NUMBER_RANGE_OBJECT_LIST Lists all number objects with their attributes . . . . . . . . .
NUMBER_RANGE_OBJECT_MAINTAIN Provides screens to maintain number object . . . . .
NUMBER_RANGE_OBJECT_READ Gets texts and attributes of number object . . . . . . . . . .
NUMBER_RANGE_OBJECT_UPDATE Copies and changes number range objects . . . . . . .

227
227
228
228
229
229
230
230
231
233
235
236

8. Office Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

ALSM_EXCEL_TO_INTERNAL_TABLE Uploads Excel spreadsheet to internal table . . . . . . .
EXCEL_OLE_STANDARD_DAT Starts Excel and transfers internal table data . . . . . . . . . . .
EXECUTE_WINWORD Opens MS Word on the PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
KCD_EXCEL_OLE_TO_INT_CONVERT Uploads data directly from Excel sheet . . . . . . . . . . .
MS_EXCEL_OLE_STANDARD_DAT Builds a file and automatically starts Excel . . . . . . . . . .
RH_START_EXCEL_WITH_DATA Starts Excel with contents of an internal table . . . . . . . . .
RS_SEND_MAIL_FOR_SPOOLLIST Sends message from program to SAPoffice . . . . . . . . .
SAP_CONVERT_TO_XLS_FORMAT Downloads internal table to Excel . . . . . . . . . . . . . . . . . .
SO_NEW_DOCUMENT_ATT_SEND_API1 Attaches a document to an e-mail . . . . . . . . . . . . .
SO_NEW_DOCUMENT_SEND_API1 Sends an express mail (SAPoffice) . . . . . . . . . . . . . . . . .
WS_EXCEL Starts MS Excel on the PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

237
238
240
241
242
244
245
246
247
249
250

9. Popup Dialogues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

Confirmation Prompt Dialogues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
C14A_POPUP_ASK_FILE_OVERWRITE Asks if file can be overwritten . . . . . . . . . . . . . . . . . . . .
CJDB_POPUP_TO_HANDLE_TIME_OUT Asks for next step if timeout occurs . . . . . . . . . . . .
POPUP_TO_CONFIRM Confirms an action before carrying out . . . . . . . . . . . . . . . . . . . . . .
POPUP_TO_CONFIRM_DATA_LOSS Confirms an action before carrying out . . . . . . . . . . . .
POPUP_TO_CONFIRM_LOSS_OF_DATA Confirms an action before carrying out . . . . . . . . .
POPUP_TO_CONFIRM_STEP Asks whether to perform processing step . . . . . . . . . . . . . . .
POPUP_TO_CONFIRM_WITH_MESSAGE Informs about a specific point during action . . .
POPUP_TO_CONFIRM_WITH_VALUE Displays a numeric value with a message . . . . . . . . .

253
253
254
256
257
258
259
260
261

Display Input Check Dialogues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

262
264
265

POPUP_GET_VALUES Creates a dialogue box for display and input . . . . . . . . . . . . . . . . .

POPUP_GET_VALUES_DB_CHECKED Inputs data to be checked against database . . . . . .
POPUP_GET_VALUES_SET_MAX_FIELD Specifies number of fields to display in dialogue . . .

00

25/09/03

15:11

Page xv

Contents

xv

POPUP_GET_VALUES_USER_BUTTONS Requests values and displays pushbuttons . . . . . .

POPUP_GET_VALUES_USER_CHECKED Input data to be checked in a user exit . . . . . . . . . .
POPUP_GET_VALUES_USER_HELP Branching in a user F1 or F4 help . . . . . . . . . . . . . . . . . . .

267
268
270

Popup Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COPO_POPUP_TO_DISPLAY_TEXTLIST Dialogue box displaying help when F1 is pressed . . .
CORRESPONDENCE_POPUP_EMAIL Dialogue box for requesting e-mail address . . . . . . .
EPS_PROGRESS_POPUP Creates a number of graphical popups . . . . . . . . . . . . . . . . . . . . .
ERGO_TEXT_SHOW Shows text in a documentation window . . . . . . . . . . . . . . . . . . . . . .
F4_CLOCK Displays a clock in a popup window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F4_DATE Displays a calendar in a popup window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F4_FILENAME Displays selection of files on local PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
F4_FILENAME_SERVER Displays selection of files on server . . . . . . . . . . . . . . . . . . . . . . . . .
F4_USER Pops up logon IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FITRV_CALCULATOR A working popup calculator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HELP_START Help values on database fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HELP_VALUES_GET_NO_DD_NAME Help values for any field . . . . . . . . . . . . . . . . . . . . . . . . . .
HELP_VALUES_GET_WITH_DD_NAME Help values on database fields . . . . . . . . . . . . . . . . . .
HELP_VALUES_GET_WITH_DD_TABLE Help values on database tables . . . . . . . . . . . . . . . . . .
HELP_VALUES_GET_WITH_TABLE Lists help values on selection screen . . . . . . . . . . . . . . . .
KD_GET_FILENAME_ON_F4 Selects files on the local PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MD_POPUP_SHOW_INTERNAL_TABLE Pops up contents of internal table . . . . . . . . . . . . . .
POPUP_CONTINUE_YES_NO Popup with the responses Yes and No . . . . . . . . . . . . . . .
POPUP_DISPLAY_TEXT Displays help documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POPUP_DISPLAY_TEXT_WITH_PARAMS Displays help documentation with parameters .
POPUP_FOR_INTERACTION General purpose popup box . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POPUP_NO_LIST Displays standard dialogue box if no data . . . . . . . . . . . . . . . . . . . . . . .
POPUP_TO_DECIDE Provides user with several push buttons . . . . . . . . . . . . . . . . . . . . . .
POPUP_TO_DECIDE_LIST Provides user with several radio buttons . . . . . . . . . . . . . . . . . .
POPUP_TO_DECIDE_WITH_MESSAGE Displays a diagnosis text . . . . . . . . . . . . . . . . . . . . . . . .
POPUP_TO_DISPLAY_TEXT Displays a two-line message . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POPUP_TO_INFORM Displays several lines of text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
POPUP_TO_SELECT_MONTH Popup to choose a month and year . . . . . . . . . . . . . . . . . . . .
POPUP_WITH_TABLE_DISPLAY Displays internal table data in a popup table . . . . . . . . . .
SO_EXPRESS_FLAG_SET Popup after user performs an action . . . . . . . . . . . . . . . . . . . . . . .
TERM_CONTROL_EDIT Pops up mini-text editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TH_POPUP Popup on a specific users screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TXW_TEXTNOTE_EDIT Pops up mini-text editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WS_MSG Displays a one-line message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

272
272
273
274
276
277
278
279
281
282
283
284
286
288
290
291
293
294
296
297
298
300
302
303
304
305
307
308
308
309
311
312
315
316
318

10. Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BP_JOB_DELETE Deletes background job(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BP_JOB_SELECT Returns a table with job(s) details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BP_JOBLOG_READ Fetches job log executions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BP_JOBLOG_SHOW Displays job log in window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JOB_CLOSE Schedules a background job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

321
321
321
324
325
325

00

25/09/03

xvi

15:11

Page xvi

Contents
JOB_OPEN Creates a background job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JOB_SUBMIT Adds a step (program) to a background job . . . . . . . . . . . . . . . . . . . . . . . .

326
327

Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CLOI_PUT_SIGN_IN_FRONT Moves negative sign of a number . . . . . . . . . . . . . . . . . . . . . . .
G_DECIMAL_PLACES_GET Number of decimal places set for currency . . . . . . . . . . . . . . .
NUMERIC_CHECK Returns the format of a number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QF05_RANDOM Returns a random number between 0 and 1 . . . . . . . . . . . . . . . . . . . . .
QF05_RANDOM_INTEGER Returns a random number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

328
328
329
329
330
331

Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
332
333
334
336
337
337
338

ADDRESS_INTO_PRINTFORM Formats an address for printing . . . . . . . . . . . . . . . . . . . . . . . .

FM_SELECTION_CRITERIA_PRINT Displays criteria used in selection screen . . . . . . . . . . . .
GET_PRINT_PARAMETERS Reads and changes spool print parameters . . . . . . . . . . . . . . .
LOAD_PRINT_PARAMETERS User default printer settings . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PRINT_SELECTIONS Builds criteria table used in selection screen . . . . . . . . . . . . . . . . . . .
SET_PRINT_PARAMETERS Sets users print settings for a report . . . . . . . . . . . . . . . . . . . . . .
STORE_PRINT_PARAMETERS Saves users current print settings . . . . . . . . . . . . . . . . . . . . . . .

Programs and Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

339
340
341
341
342
343
344
345
346
347
348
349
350
351

BAPI_TRANSACTION_COMMIT Explicitly commits a BAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

BAPI_TRANSACTION_ROLLBACK Prevents permanent changes by BAPIs . . . . . . . . . . . . . .
DEQUEUE_ESFUNCTION Unlocks program so that it can be executed . . . . . . . . . . . . . . .
ENQUE_SLEEP Waits a specified period of time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ENQUEUE_ESFUNCTION Locks program so that it cannot be executed . . . . . . . . . . . . . .
GET_COMPONENT_LIST Detailed description of fields from programs . . . . . . . . . . . . . . .
GET_FIELDTAB Retrieves table fields with field metadata . . . . . . . . . . . . . . . . . . . . . . . . .
GET_GLOBAL_SYMBOLS Returns all components of a program . . . . . . . . . . . . . . . . . . . . .
GET_INCLUDETAB Lists all INCLUDEs in a program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RFC_ABAP_INSTALL_AND_RUN Runs a program that is stored in a table . . . . . . . . . . . . . .
RPY_TRANSACTION_READ Where used for transactions and programs . . . . . . . . . . . . . .
RS_GET_ALL_INCLUDES Lists all INCLUDEs in a program . . . . . . . . . . . . . . . . . . . . . . . . . . .
RZL_SLEEP Hangs application from 1 to 5 seconds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAPGUI_SET_FUNCTIONCODE Simulates a keystroke in an ABAP report . . . . . . . . . . . . . .

Text and Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

352
353
353
354
356
357
358
359
360
360
361
362

CLPB_EXPORT Loads text table from the clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CLPB_IMPORT Sends text table to the clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RKD_WORD_WRAP Converts a long string into several lines . . . . . . . . . . . . . . . . . . . . . . .
SCP_REPLACE_STRANGE_CHARS Replaces special letters with normal text . . . . . . . . . . . .
SPELL_AMOUNT Converts numeric amount into characters . . . . . . . . . . . . . . . . . . . . . . .
STRING_CENTER Centres a string within another . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRING_CONCATENATE Joins two strings together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRING_CONCATENATE_3 Joins three strings together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRING_LENGTH Returns the length of a string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRING_MOVE_RIGHT Shifts a string right . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRING_REVERSE Returns a string in reverse order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STRING_SPLIT Splits a string into smaller strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

00

25/09/03

15:11

Page xvii

Contents

xvii

STRING_UPPER_LOWER_CASE Converts string to proper case . . . . . . . . . . . . . . . . . . . . . . . .

SWA_STRING_SPLIT Splits a string into smaller strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEXT_SPLIT Splits text into smaller strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

363
364
365

Various . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CALL_BROWSER Calls default web browser or file manger . . . . . . . . . . . . . . . . . . . . . . . .
CHANGEDOCUMENT_READ_HEADERS Gets change document header . . . . . . . . . . . . . . . . .
CHANGEDOCUMENT_READ_POSITIONS Gets change document details . . . . . . . . . . . . . . . .
CL_TABLE_EDITOR Displays and edits internal table data . . . . . . . . . . . . . . . . . . . . . . . . . .
CSAP_MAT_BOM_READ Displays simple material BOMs . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDIF_FIELDINFO_GET Information about tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FORMAT_MESSAGE Formats error message for display . . . . . . . . . . . . . . . . . . . . . . . . . . . .
K_WERKS_OF_BUKRS_FIND Lists all plants for a given company code . . . . . . . . . . . . . . . .
MATERIAL_BTCI_SELECTION_NEW Selects the correct views on material master . . . . . . .
MATERIAL_BTCI_TEXT BDC fields and OK codes for materials . . . . . . . . . . . . . . . . . . . . . . .
REGISTRY_GET Reads an entry from the registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REGISTRY_SET Sets an entry in the registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RV_ORDER_FLOW_INFORMATION Reads sales document flow . . . . . . . . . . . . . . . . . . . . . . . .
WRITE_MESSAGE Formats error message for display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

366
366
367
369
370
371
372
373
374
375
377
378
379
380
381

Appendix Tables Used in Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

http://www.springer.com/978-1-85233-775-9