Shared Top Border

Enterprise Resource
Planning Portal

 

Advertise | Founder BLOG

ERPGenie.COM ABAP Tips and Tricks Database

THE ultimate
ERP website

 

Forums | Vote for us |

Google    Other Search Options

Home arrow Tips and Tricks arrow General arrow Good to know function modules
Good to know function modules PDF Print E-mail
User Rating: / 4
PoorBest 
Written by Kevin Wilson   
Wednesday, 07 February 2007

Here's a comprehensive list of function modules with descriptions of what they do. 

Name

Description

USEREXIT_KOMKBV1_FILL

 User exit to update communication structure at header level. In function module KOMKBV1_FILL called from SAPMV45A.

MASTER_IDOC_DISTRIBUTE

 Send an outbound IDoc

IDOC_STATUS_WRITE_TO_DATABASE

 Write status of an IDoc to EDIDS

IDOC_TYPE_COMPLETE_READ

 Reads full IDoc structure and field documentation. Offsets, types, etc…..

ABAP_DOCU_DOWNLOAD

 Download ABAP documentation in HTML format.

ARFC_GET_TID

 will return the IP address of the terminal in hex.   

BAL_*

 All function modules used for SAP's application logging can be found here.

BP_EVENT_RAISE

 Trigger an event from ABAP/4 program

BP_JOBLOG_READ

 Fetch job log executions

CLOI_PUT_SIGN_IN_FRONT

 Place the negative sign after a number.  SAP default is place the negative sign after the number.

CLPB_EXPORT

 Export a text table to the clipboard (on presentation server)

CLPB_IMPORT

 Import a Text Table from the Clipboard (on presentation server)

COMMIT_TEXT

 To load long text into SAP

CONVERSION_EXIT_ALPHA_INPUT

 converts any number into a string fill with zeroes right

CONVERSION_EXIT_ALPHA_OUTPUT

 converts any number with zeroes right into a simple integer

CONVERT_OTF

 Convert SAP documents (SAPScript) to other types.

DATE_GET_WEEK

 will return the week that a date is in.

DATE_CHECK_PLAUSIBILITY

 Check to see if a date is in a valid format for SAP.  Works well when validating dates being passed in from other systems.

DOWNLOAD

 download a file to the presentation server (PC)

DYNP_VALUES_READ

 Read the values from a dynpro.  This function can be used to read the values from a report's selection screen too (Another example).

DYNP_VALUES_UPDATE

 Similar to DYNP_VALUES_READ, this function will allow the updating of fields on a dynpro.  Very useful when you want to change a field based on the value entered for another field.

ENQUE_SLEEP

 Wait a specified period of time before continuing processing.

ENQUEUE_ESFUNCTION

 Lock an abap program so that it cannot be executed.  Set the parameters as follows:

EPS_GET_FILE_ATTRIBUTES

 Pass in a filename and a path, and will return attributes for the file

EPS_GET_DIRECTORY_LISTING

 return a list of filenames from a local or network drive

F4_DATE

 displays a calendar in a popup window and allows user to choose a date, or it can be displayed read only.

F4IF_SHLP_EXIT_EXAMPLE

 documents the different reasons to use a search help exit, and shows how it is done.

FILENAME_GET

 popup to get a filename from a user, returns blank filename if user selects cancel

FTP_CONNECT

 Open a connection (and log in) to an FTP server

FTP_COMMAND

 Execute a command on the FTP server

FTP_DISCONNECT

 Close the connection (and log off) the FTP server

FORMAT_MESSAGE

 Takes a message id and number, and puts it into a variable. Works better than WRITE_MESSAGE, since some messages use $ as a place holder, and WRITE_MESSAGE does not accommadate that, it only replaces the ampersands (&) in the message.

GET_GLOBAL_SYMBOLS

 Returns a list of all tables, select options, texts, etc for a program.  Even includes the text definitions for the selection screen

GET_INCLUDETAB

 Returns a list of all INCLUDES in a program

G_SET_GET_ALL_VALUES

 Fetch values from a set.

GUI_CREATE_DIRECTORY

 Create a directory on the presentation server

GUI_DELETE_FILE

 Replaces WS_FILE_DELETE. Delete a file on the presentation server

GUI_DOWNLOAD

 Replaces WS_DOWNLOAD. Download table from the app server to presentation server

GUI_EXEC

 Replaces WS_EXECUTE. Start a File or Program Asynchronously with WinExec

GUI_GET_DESKTOP_INFO

 Replaces WS_QUERY. Delivers Information About the Desktop (client)

GUI_REMOVE_DIRECTORY

 Delete a directory on the presentation server

GUI_RUN

 Start a File or Program Asynchronously with ShellExecute

GUI_UPLOAD

 Replaces WS_UPLOAD. Upoad file from presentation server to the app server

HELP_START

 Display help for a field.  Useful for doing AT SELECTION SCREEN ON VALUE REQUEST for those fields that do not provide F4 help at the DDIC level.

HOLIDAY_GET

 Provides a table of all the holidays based upon a Factory Calendar &/ Holiday Calendar.

HR_DISPLAY_BASIC_LIST

 is an HR function, but can be used for any data.  You pass it data, and column headers, and it provides a table control with the ability to manipulate the data, and send it to Word or Excel. Also see the additional documentation here.

HR_GET_LEAVE_DATA

 Get all leave information (includes leave entitlement, used holidays/paid out holidays)  

INIT_TEXT

 To load long text into SAP

K_WERKS_OF_BUKRS_FIND

 Return a list of all plants for a given company code.

LIST_TO_ASCII

 convert an ABAP report (displayed on screen) from OTF to ASCII format LIST_FROM_MEMORY.  Retrieves the output of a report from memory when the report was executed using SUBMIT... EXPORTING LIST TO MEMORY. See also WRITE_LIST.

MONTH_NAMES_GET

 It returns all the month and names in repective language.

MS_EXCEL_OLE_STANDARD_OLE

 will build a file, and automatically start Excel

OTF_CONVERT

 wraps several other function modules.  Will convert OTF to ASCII or PDF

CONVERT_OTFSPOOLJOB_2_PDF

 converts a OTF spool to PDF (i.e. Sapscript document)

CONVERT_ABAPSPOOLJOB_2_PDF

 convert abap spool output to PDF

POPUP_TO_CONFIRM_LOSS_OF_DATA

 Create a dialog box in which you make a question whether the user wishes to perform a processing step with loss of data.

POPUP_TO_CONFIRM_STEP

 Create a dialog box in which you make a question whether the user wishes to perform the step.

POPUP_TO_CONFIRM_WITH_MESSAGE

 Create a dialog box in which you inform the user about a specific decision point during an action.

POPUP_TO_CONFIRM_WITH_VALUE

 Create a dialog box in which you make a question whether the user wishes to perform a processing step with a particular object.

POPUP_TO_DECIDE

 Provide user with several choices as radio buttons  

POPUP_TO_DECIDE_WITH_MESSAGE

 Create a dialog box in which you inform the user about a specific decision point via a diagnosis text.

POPUP_TO_DISPLAY_TEXT

 Create a dialog box in which you display a two line message

POPUP_TO_SELECT_MONTH

 Popup to choose a month

POPUP_WITH_TABLE_DISPLAY

 Provide a display of a table for user to select one, with the value of the table line returned when selected.

PRICING

 Return pricing conditions in an internal table.  Use structure TCOMK for parameter COMM_HEAD_1, and structure TCOMP for parameter COMM_ITEM_1, and set CALCULATION_TYPE to B.  The pricing conditions will be returned in XOMV.  You must fill TCOMP, and TCOMK with the appropriate values before callling the function in order for it to work.

PROFILE_GET

 Read an Entry in an INI File on the frontend

PROFILE_SET

 Write an Entry in an INI File on the frontend

READ_TEXT

 To load long text into SAP

REGISTRY_GET

 Read an Entry from the Registry

REGISTRY_SET

 Set an entry in the Registry

RFC_ABAP_INSTALL_AND_RUN

 Runs an ABAP program that is stored in the table PROGRAM when the MODE = 'F'.  Table WRITES contains the ouput of the program. Allows you to run a program without having the source code in the target system.

RH_GET_ACTIVE_WF_PLVAR

 Return the active HR Plan

RH_GET_DATE_DAYNAME

 return the day based on the date provied

RH_START_EXCEL_WITH_DATA

starts Excel with the contents of an internal table.  This function finds Excel in the desktop registry. It also uses a local PC working directory to save the file (that's what the "W" value for data path flag does). Very transparent to user!

RH_STRUC_GET

 Returns all related org info

RP_CALC_DATE_IN_INTERVAL

 Add/subtract years/months/days from a date

RP_LAST_DAY_OF_MONTHS

 Determine last day of month

RPY_DYNPRO_READ

 Read dynpro, including screen flow

RPY_TRANSACTION_READ

 Given a transaction, return the program and screen or given a program and screen, return the transactions that use the program and screen.

RS_COVERPAGE_SELECTIONS

 Returns an internal table that contains a formatted list of all the selection parameters entered for a report.  Table is ready to print out.

RS_REFRESH_FROM_SELECTOPTIONS

 Get the current contents of selection screen

RS_SEND_MAIL_FOR_SPOOLLIST

 Send message from ABAP/4 program to SAPoffice.

RS_VARIANT_CONTENTS

 Returns the contents of the specified variant in a table.

RSWWWIDE

 Removes workitems from the database.

RZL_SLEEP

 Hang the current application from 1 to 5 seconds.

RZL_SUBMIT

 Submit a remote report.

RZL_READ_DIR_LOCAL

 Read a directory on the Application Server

RZL_READ_DIR

 If the server name is left blank, it reads a directory from local presentation server, otherwise it reads the directory of the remote server

RZL_READ_FILE

 Read a file from the presentation server if no server name is given, or read file from remote server. Very useful to avoid authority checks that occur doing an OPEN DATASET. This function using a SAP C program to read the data.

RZL_WRITE_FILE_LOCAL

 Saves table to the presentation server (not PC). Does not use OPEN DATASET, so it does not suffer from authority checks!

SAPGUI_PROGRESS_INDICATOR

 Display a progress bar on the SAP GUI, and give the user some idea of what is happening

SAVE_TEXT

 To load long text into SAP

SCROLLING_IN_TABLE

If you are coding a module pool and using a table-control, you can use this function SCROLLING_IN_TABLE to handle any scrolling. (provided by Paul Kjaer)

SD_DATETIME_DIFFERENCE

 Give the difference in Days and Time for 2 dates         

SO_NEW_DOCUMENT_ATT_SEND_API1

 Send a document as part of an email. The documentation is better than normal for this function, so please read it.

SO_SPLIT_FILE_AND_PATH

 Split a fully pathed filename into a filename and a path.

SO_SPOOL_READ

 Fetch printer spool according to the spool number informed.

SO_WIND_SPOOL_LIST

 Browse printer spool numbers according to user informed.

SX_OBJECT_CONVERT_OTF_PDF

 Conversion From OTF to PDF (SAPScript conversion)

SX_OBJECT_CONVERT_OTF_PRT

 Conversion From OTF to Printer Format (SAPScript conversion)

SX_OBJECT_CONVERT_OTF_RAW

 Conversion From OTF to ASCII (SAPScript conversion)

SXPG_CALL_SYSTEM

  you can check the user's authorization for the specified command and run the command. The command runs on the host system on which the function module is executed. The function module is RFC-capable. It can therefore be run on the host system at which a user happens to be active or on another designated host system at which an R/3 server is active.

SXPG_COMMAND_LIST_GET

 Select a list of external OS command definitions.

SXPG_COMMAND_DEFINITION_GET

 Read the definition of a single external OS command from the R/3 System's database.

SXPG_COMMAND_CHECK

 Check whether the user is authorized to execute the specified command on the target host system with the specified arguments.

SXPG_COMMAND_EXECUTE

 Check a user's authorization to use a command, as in SXPG_COMMAND_CHECK. If the authorization check is successful, then execute the command on the target host system.

TERMINAL_ID_GET

 Return the terminal id

TH_DELETE_USER

 Logoff a user.  Similar results to using SM04.

TH_ENVIRONMENT

 Get the UNIX environment

TH_POPUP

 Display a popup system message on a specific users screen.