SAP DOCUMENT_HANDLING Function Module for NOTRANSL: Bearbeiten von Dokumentinfosätzen
DOCUMENT_HANDLING is a standard document handling SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for NOTRANSL: Bearbeiten von Dokumentinfosätzen processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.
See here to view full function module documentation and code listing for document handling FM, simply by entering the name DOCUMENT_HANDLING into the relevant SAP transaction such as SE37 or SE38.
Function Group: CV00
Program Name: SAPLCV00
Main Program: SAPLCV00
Appliation area: M
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:
Function DOCUMENT_HANDLING pattern details
In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.CALL FUNCTION 'DOCUMENT_HANDLING'"NOTRANSL: Bearbeiten von Dokumentinfosätzen.
EXPORTING
* API_MODE_USED = ' ' "
* UPDATE_MODE = "
* IN_PROTF = ' ' "
* IN_DRAW = ' ' "Transferred values
* IN_TKTTXT = "
* NOT_DEQUEUE_ALL = ' ' "
* NO_CHANGE_TRANSMITTED_FIELDS = ' ' "
* REFAR = ' ' "
* REFNR = ' ' "
* REFTL = ' ' "
* REFVR = ' ' "
* BINPT_MODE_USED = ' ' "
* OK_CODE = ' ' "
* IF_COPY_COPY_CLASS_DATA = ' ' "
DAR = "
DNR = "
DTL = "
DVR = "
* SUPPRESS_FLAG = ' ' "
TRANSACTION_CODE = "
* UPDATE_IMMEDIATELY = ' ' "
IMPORTING
DOKNR = "
MSGV3 = "
MSGV4 = "
UPDATE = "
DOKAR = "
DOKVR = "
TLDOK = "
MSGID = "
MSGNO = "
MSGTY = "
MSGV1 = "
MSGV2 = "
EXCEPTIONS
ERROR = 1
Customer Function user exits
Below is a list of CUSTOMER FUNCTION exit user exits that are available within this program and maybe relevant for this FM.EXIT_SAPLCV00_001 Exit for check_in before files transport
EXIT_SAPLCV00_002 Exit for check in after file transport
IMPORTING Parameters details for DOCUMENT_HANDLING
API_MODE_USED -
Data type: MCDOK-MARAFDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
UPDATE_MODE -
Data type:Optional: Yes
Call by Reference: No ( called with pass by value option)
IN_PROTF -
Data type: DRAP-PROTFDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
IN_DRAW - Transferred values
Data type: DRAWDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
IN_TKTTXT -
Data type: TKTTXTOptional: Yes
Call by Reference: No ( called with pass by value option)
NOT_DEQUEUE_ALL -
Data type:Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
NO_CHANGE_TRANSMITTED_FIELDS -
Data type:Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
REFAR -
Data type: MCDOK-REFARDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
REFNR -
Data type: MCDOK-REFNRDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
REFTL -
Data type: MCDOK-REFTLDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
REFVR -
Data type: MCDOK-REFVRDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
BINPT_MODE_USED -
Data type: MCDOK-MARAFDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
OK_CODE -
Data type: RSEU1-FUNCDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
IF_COPY_COPY_CLASS_DATA -
Data type: MCDOK-MARAFDefault: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
DAR -
Data type: DRAW-DOKAROptional: No
Call by Reference: No ( called with pass by value option)
DNR -
Data type: DRAW-DOKNROptional: No
Call by Reference: No ( called with pass by value option)
DTL -
Data type: DRAW-DOKTLOptional: No
Call by Reference: No ( called with pass by value option)
DVR -
Data type: DRAW-DOKVROptional: No
Call by Reference: No ( called with pass by value option)
SUPPRESS_FLAG -
Data type:Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
TRANSACTION_CODE -
Data type: SY-TCODEOptional: No
Call by Reference: No ( called with pass by value option)
UPDATE_IMMEDIATELY -
Data type:Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)
EXPORTING Parameters details for DOCUMENT_HANDLING
DOKNR -
Data type: DRAW-DOKNROptional: No
Call by Reference: No ( called with pass by value option)
MSGV3 -
Data type: SY-MSGV3Optional: No
Call by Reference: No ( called with pass by value option)
MSGV4 -
Data type: SY-MSGV4Optional: No
Call by Reference: No ( called with pass by value option)
UPDATE -
Data type:Optional: No
Call by Reference: No ( called with pass by value option)
DOKAR -
Data type: DRAW-DOKAROptional: No
Call by Reference: No ( called with pass by value option)
DOKVR -
Data type: DRAW-DOKVROptional: No
Call by Reference: No ( called with pass by value option)
TLDOK -
Data type: DRAW-DOKTLOptional: No
Call by Reference: No ( called with pass by value option)
MSGID -
Data type: SY-MSGIDOptional: No
Call by Reference: No ( called with pass by value option)
MSGNO -
Data type: SY-MSGNOOptional: No
Call by Reference: No ( called with pass by value option)
MSGTY -
Data type: SY-MSGTYOptional: No
Call by Reference: No ( called with pass by value option)
MSGV1 -
Data type: SY-MSGV1Optional: No
Call by Reference: No ( called with pass by value option)
MSGV2 -
Data type: SY-MSGV2Optional: No
Call by Reference: No ( called with pass by value option)
EXCEPTIONS details
ERROR -
Data type:Optional: No
Call by Reference: No ( called with pass by value option)
Copy and paste ABAP code example for DOCUMENT_HANDLING Function Module
The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.DATA: | ||||
lv_doknr | TYPE DRAW-DOKNR, " | |||
lv_error | TYPE DRAW, " | |||
lv_api_mode_used | TYPE MCDOK-MARAF, " ' ' | |||
lv_msgv3 | TYPE SY-MSGV3, " | |||
lv_update_mode | TYPE SY, " | |||
lv_msgv4 | TYPE SY-MSGV4, " | |||
lv_in_protf | TYPE DRAP-PROTF, " ' ' | |||
lv_update | TYPE DRAP, " | |||
lv_in_draw | TYPE DRAW, " ' ' | |||
lv_in_tkttxt | TYPE TKTTXT, " | |||
lv_not_dequeue_all | TYPE TKTTXT, " ' ' | |||
lv_no_change_transmitted_fields | TYPE TKTTXT, " ' ' | |||
lv_refar | TYPE MCDOK-REFAR, " ' ' | |||
lv_refnr | TYPE MCDOK-REFNR, " ' ' | |||
lv_reftl | TYPE MCDOK-REFTL, " ' ' | |||
lv_refvr | TYPE MCDOK-REFVR, " ' ' | |||
lv_dokar | TYPE DRAW-DOKAR, " | |||
lv_binpt_mode_used | TYPE MCDOK-MARAF, " ' ' | |||
lv_ok_code | TYPE RSEU1-FUNC, " ' ' | |||
lv_if_copy_copy_class_data | TYPE MCDOK-MARAF, " ' ' | |||
lv_dar | TYPE DRAW-DOKAR, " | |||
lv_dokvr | TYPE DRAW-DOKVR, " | |||
lv_dnr | TYPE DRAW-DOKNR, " | |||
lv_tldok | TYPE DRAW-DOKTL, " | |||
lv_dtl | TYPE DRAW-DOKTL, " | |||
lv_msgid | TYPE SY-MSGID, " | |||
lv_dvr | TYPE DRAW-DOKVR, " | |||
lv_msgno | TYPE SY-MSGNO, " | |||
lv_msgty | TYPE SY-MSGTY, " | |||
lv_suppress_flag | TYPE SY, " ' ' | |||
lv_msgv1 | TYPE SY-MSGV1, " | |||
lv_transaction_code | TYPE SY-TCODE, " | |||
lv_msgv2 | TYPE SY-MSGV2, " | |||
lv_update_immediately | TYPE SY. " ' ' |
  CALL FUNCTION 'DOCUMENT_HANDLING' "NOTRANSL: Bearbeiten von Dokumentinfosätzen |
EXPORTING | ||
API_MODE_USED | = lv_api_mode_used | |
UPDATE_MODE | = lv_update_mode | |
IN_PROTF | = lv_in_protf | |
IN_DRAW | = lv_in_draw | |
IN_TKTTXT | = lv_in_tkttxt | |
NOT_DEQUEUE_ALL | = lv_not_dequeue_all | |
NO_CHANGE_TRANSMITTED_FIELDS | = lv_no_change_transmitted_fields | |
REFAR | = lv_refar | |
REFNR | = lv_refnr | |
REFTL | = lv_reftl | |
REFVR | = lv_refvr | |
BINPT_MODE_USED | = lv_binpt_mode_used | |
OK_CODE | = lv_ok_code | |
IF_COPY_COPY_CLASS_DATA | = lv_if_copy_copy_class_data | |
DAR | = lv_dar | |
DNR | = lv_dnr | |
DTL | = lv_dtl | |
DVR | = lv_dvr | |
SUPPRESS_FLAG | = lv_suppress_flag | |
TRANSACTION_CODE | = lv_transaction_code | |
UPDATE_IMMEDIATELY | = lv_update_immediately | |
IMPORTING | ||
DOKNR | = lv_doknr | |
MSGV3 | = lv_msgv3 | |
MSGV4 | = lv_msgv4 | |
UPDATE | = lv_update | |
DOKAR | = lv_dokar | |
DOKVR | = lv_dokvr | |
TLDOK | = lv_tldok | |
MSGID | = lv_msgid | |
MSGNO | = lv_msgno | |
MSGTY | = lv_msgty | |
MSGV1 | = lv_msgv1 | |
MSGV2 | = lv_msgv2 | |
EXCEPTIONS | ||
ERROR = 1 | ||
. " DOCUMENT_HANDLING |
ABAP code using 7.40 inline data declarations to call FM DOCUMENT_HANDLING
The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8."SELECT single DOKNR FROM DRAW INTO @DATA(ld_doknr). | ||||
"SELECT single MARAF FROM MCDOK INTO @DATA(ld_api_mode_used). | ||||
DATA(ld_api_mode_used) | = ' '. | |||
"SELECT single MSGV3 FROM SY INTO @DATA(ld_msgv3). | ||||
"SELECT single MSGV4 FROM SY INTO @DATA(ld_msgv4). | ||||
"SELECT single PROTF FROM DRAP INTO @DATA(ld_in_protf). | ||||
DATA(ld_in_protf) | = ' '. | |||
DATA(ld_in_draw) | = ' '. | |||
DATA(ld_not_dequeue_all) | = ' '. | |||
DATA(ld_no_change_transmitted_fields) | = ' '. | |||
"SELECT single REFAR FROM MCDOK INTO @DATA(ld_refar). | ||||
DATA(ld_refar) | = ' '. | |||
"SELECT single REFNR FROM MCDOK INTO @DATA(ld_refnr). | ||||
DATA(ld_refnr) | = ' '. | |||
"SELECT single REFTL FROM MCDOK INTO @DATA(ld_reftl). | ||||
DATA(ld_reftl) | = ' '. | |||
"SELECT single REFVR FROM MCDOK INTO @DATA(ld_refvr). | ||||
DATA(ld_refvr) | = ' '. | |||
"SELECT single DOKAR FROM DRAW INTO @DATA(ld_dokar). | ||||
"SELECT single MARAF FROM MCDOK INTO @DATA(ld_binpt_mode_used). | ||||
DATA(ld_binpt_mode_used) | = ' '. | |||
"SELECT single FUNC FROM RSEU1 INTO @DATA(ld_ok_code). | ||||
DATA(ld_ok_code) | = ' '. | |||
"SELECT single MARAF FROM MCDOK INTO @DATA(ld_if_copy_copy_class_data). | ||||
DATA(ld_if_copy_copy_class_data) | = ' '. | |||
"SELECT single DOKAR FROM DRAW INTO @DATA(ld_dar). | ||||
"SELECT single DOKVR FROM DRAW INTO @DATA(ld_dokvr). | ||||
"SELECT single DOKNR FROM DRAW INTO @DATA(ld_dnr). | ||||
"SELECT single DOKTL FROM DRAW INTO @DATA(ld_tldok). | ||||
"SELECT single DOKTL FROM DRAW INTO @DATA(ld_dtl). | ||||
"SELECT single MSGID FROM SY INTO @DATA(ld_msgid). | ||||
"SELECT single DOKVR FROM DRAW INTO @DATA(ld_dvr). | ||||
"SELECT single MSGNO FROM SY INTO @DATA(ld_msgno). | ||||
"SELECT single MSGTY FROM SY INTO @DATA(ld_msgty). | ||||
DATA(ld_suppress_flag) | = ' '. | |||
"SELECT single MSGV1 FROM SY INTO @DATA(ld_msgv1). | ||||
"SELECT single TCODE FROM SY INTO @DATA(ld_transaction_code). | ||||
"SELECT single MSGV2 FROM SY INTO @DATA(ld_msgv2). | ||||
DATA(ld_update_immediately) | = ' '. | |||
Search for further information about these or an SAP related objects