SAP CVALE_DOC_CHECKOUT Function Module for NOTRANSL: ALE: Dokumente auschecken









CVALE_DOC_CHECKOUT is a standard cvale doc checkout 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: ALE: Dokumente auschecken 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 cvale doc checkout FM, simply by entering the name CVALE_DOC_CHECKOUT into the relevant SAP transaction such as SE37 or SE38.

Function Group: CVALE
Program Name: SAPLCVALE
Main Program: SAPLCVALE
Appliation area: M
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function CVALE_DOC_CHECKOUT 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 'CVALE_DOC_CHECKOUT'"NOTRANSL: ALE: Dokumente auschecken
  EXPORTING
   PS_DRAW =  "Document Data
*  PF_FILENO = '1' "
*  PF_COMP_GET = 'X' "Additional Files
*  PF_TARGETPATH = ' ' "Target Path
*  PF_TARGETFILE = ' ' "Target File
*  PF_FTP_DEST = ' ' "FTP Destination

 IMPORTING
   PSX_MESSAGES =  "Messages
   PFX_CONTENT_PROVIDE =  "How is the content of the original transferred
   PFX_ERROR =  "Document Management Flag

TABLES
*  PT_DRAZ =  "
*  PTX_DRAO =  "
*  PTX_DRAOZ =  "
.




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_SAPLCVALE_001 User exit for ALE-DMS (DOCMAS inbound)
EXIT_SAPLCVALE_002 User exit for ALE-DMS (DOCMAS outbound)
EXIT_SAPLCVALE_003 User exit for ALE-DMS (DOLMAS inbound)
EXIT_SAPLCVALE_004 User exit for ALE-DMS (DOLMAS outbound)
EXIT_SAPLCVALE_005 Userexit for filter objects (ALE outbound)
EXIT_SAPLCVALE_006 User Exit for ALE-DVC (DOCMAS Outbound, BOMDOC Control)

IMPORTING Parameters details for CVALE_DOC_CHECKOUT

PS_DRAW - Document Data

Data type: DRAW
Optional: No
Call by Reference: No ( called with pass by value option)

PF_FILENO -

Data type: MCDOK-ACTION
Default: '1'
Optional: Yes
Call by Reference: No ( called with pass by value option)

PF_COMP_GET - Additional Files

Data type: MCDOK-ACTION
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

PF_TARGETPATH - Target Path

Data type: DRAW-FILEP
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

PF_TARGETFILE - Target File

Data type: DRAW-FILEP
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

PF_FTP_DEST - FTP Destination

Data type: RFCDES-RFCDEST
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for CVALE_DOC_CHECKOUT

PSX_MESSAGES - Messages

Data type: MESSAGES
Optional: No
Call by Reference: No ( called with pass by value option)

PFX_CONTENT_PROVIDE - How is the content of the original transferred

Data type: MCDOK-CONTENT_PROVIDE
Optional: No
Call by Reference: No ( called with pass by value option)

PFX_ERROR - Document Management Flag

Data type: MCDOK-ACTION
Optional: No
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for CVALE_DOC_CHECKOUT

PT_DRAZ -

Data type: DRAZ
Optional: Yes
Call by Reference: No ( called with pass by value option)

PTX_DRAO -

Data type: DRAO
Optional: Yes
Call by Reference: Yes

PTX_DRAOZ -

Data type: DRAOZ
Optional: Yes
Call by Reference: Yes

Copy and paste ABAP code example for CVALE_DOC_CHECKOUT 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_ps_draw  TYPE DRAW, "   
lt_pt_draz  TYPE STANDARD TABLE OF DRAZ, "   
lv_psx_messages  TYPE MESSAGES, "   
lt_ptx_drao  TYPE STANDARD TABLE OF DRAO, "   
lv_pf_fileno  TYPE MCDOK-ACTION, "   '1'
lv_pfx_content_provide  TYPE MCDOK-CONTENT_PROVIDE, "   
lv_pfx_error  TYPE MCDOK-ACTION, "   
lt_ptx_draoz  TYPE STANDARD TABLE OF DRAOZ, "   
lv_pf_comp_get  TYPE MCDOK-ACTION, "   'X'
lv_pf_targetpath  TYPE DRAW-FILEP, "   SPACE
lv_pf_targetfile  TYPE DRAW-FILEP, "   SPACE
lv_pf_ftp_dest  TYPE RFCDES-RFCDEST. "   SPACE

  CALL FUNCTION 'CVALE_DOC_CHECKOUT'  "NOTRANSL: ALE: Dokumente auschecken
    EXPORTING
         PS_DRAW = lv_ps_draw
         PF_FILENO = lv_pf_fileno
         PF_COMP_GET = lv_pf_comp_get
         PF_TARGETPATH = lv_pf_targetpath
         PF_TARGETFILE = lv_pf_targetfile
         PF_FTP_DEST = lv_pf_ftp_dest
    IMPORTING
         PSX_MESSAGES = lv_psx_messages
         PFX_CONTENT_PROVIDE = lv_pfx_content_provide
         PFX_ERROR = lv_pfx_error
    TABLES
         PT_DRAZ = lt_pt_draz
         PTX_DRAO = lt_ptx_drao
         PTX_DRAOZ = lt_ptx_draoz
. " CVALE_DOC_CHECKOUT




ABAP code using 7.40 inline data declarations to call FM CVALE_DOC_CHECKOUT

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 ACTION FROM MCDOK INTO @DATA(ld_pf_fileno).
DATA(ld_pf_fileno) = '1'.
 
"SELECT single CONTENT_PROVIDE FROM MCDOK INTO @DATA(ld_pfx_content_provide).
 
"SELECT single ACTION FROM MCDOK INTO @DATA(ld_pfx_error).
 
 
"SELECT single ACTION FROM MCDOK INTO @DATA(ld_pf_comp_get).
DATA(ld_pf_comp_get) = 'X'.
 
"SELECT single FILEP FROM DRAW INTO @DATA(ld_pf_targetpath).
DATA(ld_pf_targetpath) = ' '.
 
"SELECT single FILEP FROM DRAW INTO @DATA(ld_pf_targetfile).
DATA(ld_pf_targetfile) = ' '.
 
"SELECT single RFCDEST FROM RFCDES INTO @DATA(ld_pf_ftp_dest).
DATA(ld_pf_ftp_dest) = ' '.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!