SAP CVAPI_DOC_CHECKOUTVIEW Function Module for NOTRANSL: DVS: Dokument zum Viewen auschecken









CVAPI_DOC_CHECKOUTVIEW is a standard cvapi doc checkoutview 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: DVS: Dokument zum Viewen 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 cvapi doc checkoutview FM, simply by entering the name CVAPI_DOC_CHECKOUTVIEW into the relevant SAP transaction such as SE37 or SE38.

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



Function CVAPI_DOC_CHECKOUTVIEW 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 'CVAPI_DOC_CHECKOUTVIEW'"NOTRANSL: DVS: Dokument zum Viewen auschecken
  EXPORTING
   PF_DOKAR =  "Dokumentart
*  PF_STD_URL = 'X' "' ': Data Provider URL, 'X': HTTP-URL (KPRO)
*  PF_EXT_CALL = ' ' "
   PF_DOKNR =  "Dokumentnummer
   PF_DOKVR =  "Dokumentversion
   PF_DOKTL =  "Teildokument
*  PF_FTP_DEST = ' ' "FTP-Destination
*  PF_HTTP_DEST = ' ' "HTTP-Destination
*  PF_HOSTNAME = ' ' "Rechnername des Frontends
*  PF_CONTENT_PROVIDE = ' ' "Checkout auf Frontent,Appl.-Server,Tabelle,URL
*  PS_API_CONTROL =  "DVS: Steuerung für APIS

 IMPORTING
   PSX_MESSAGE =  "Anwendungs-Log: Protokollnummer
   PSX_DRAW =  "Dokumentinformationssatz

TABLES
*  PT_FILES =  "Originale
*  PTX_COMPONENTS =  "Zusatzdateien
*  PTX_CONTENT =  "Dateiinhalt als Tabelle
.



IMPORTING Parameters details for CVAPI_DOC_CHECKOUTVIEW

PF_DOKAR - Dokumentart

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

PF_STD_URL - ' ': Data Provider URL, 'X': HTTP-URL (KPRO)

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

PF_EXT_CALL -

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

PF_DOKNR - Dokumentnummer

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

PF_DOKVR - Dokumentversion

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

PF_DOKTL - Teildokument

Data type: DRAW-DOKTL
Optional: No
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)

PF_HTTP_DEST - HTTP-Destination

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

PF_HOSTNAME - Rechnername des Frontends

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

PF_CONTENT_PROVIDE - Checkout auf Frontent,Appl.-Server,Tabelle,URL

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

PS_API_CONTROL - DVS: Steuerung für APIS

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

EXPORTING Parameters details for CVAPI_DOC_CHECKOUTVIEW

PSX_MESSAGE - Anwendungs-Log: Protokollnummer

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

PSX_DRAW - Dokumentinformationssatz

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

TABLES Parameters details for CVAPI_DOC_CHECKOUTVIEW

PT_FILES - Originale

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

PTX_COMPONENTS - Zusatzdateien

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

PTX_CONTENT - Dateiinhalt als Tabelle

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

Copy and paste ABAP code example for CVAPI_DOC_CHECKOUTVIEW 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_pf_dokar  TYPE DRAW-DOKAR, "   
lt_pt_files  TYPE STANDARD TABLE OF CVAPI_DOC_FILE, "   
lv_psx_message  TYPE MESSAGES, "   
lv_pf_std_url  TYPE XFELD, "   'X'
lv_pf_ext_call  TYPE CHAR1, "   SPACE
lv_pf_doknr  TYPE DRAW-DOKNR, "   
lv_psx_draw  TYPE DRAW, "   
lt_ptx_components  TYPE STANDARD TABLE OF CVAPI_DOC_COMP, "   
lv_pf_dokvr  TYPE DRAW-DOKVR, "   
lt_ptx_content  TYPE STANDARD TABLE OF DRAO, "   
lv_pf_doktl  TYPE DRAW-DOKTL, "   
lv_pf_ftp_dest  TYPE RFCDES-RFCDEST, "   SPACE
lv_pf_http_dest  TYPE RFCDES-RFCDEST, "   SPACE
lv_pf_hostname  TYPE TDWD-NTADR, "   SPACE
lv_pf_content_provide  TYPE MCDOK-CONTENT_PROVIDE, "   SPACE
lv_ps_api_control  TYPE CVAPI_API_CONTROL. "   

  CALL FUNCTION 'CVAPI_DOC_CHECKOUTVIEW'  "NOTRANSL: DVS: Dokument zum Viewen auschecken
    EXPORTING
         PF_DOKAR = lv_pf_dokar
         PF_STD_URL = lv_pf_std_url
         PF_EXT_CALL = lv_pf_ext_call
         PF_DOKNR = lv_pf_doknr
         PF_DOKVR = lv_pf_dokvr
         PF_DOKTL = lv_pf_doktl
         PF_FTP_DEST = lv_pf_ftp_dest
         PF_HTTP_DEST = lv_pf_http_dest
         PF_HOSTNAME = lv_pf_hostname
         PF_CONTENT_PROVIDE = lv_pf_content_provide
         PS_API_CONTROL = lv_ps_api_control
    IMPORTING
         PSX_MESSAGE = lv_psx_message
         PSX_DRAW = lv_psx_draw
    TABLES
         PT_FILES = lt_pt_files
         PTX_COMPONENTS = lt_ptx_components
         PTX_CONTENT = lt_ptx_content
. " CVAPI_DOC_CHECKOUTVIEW




ABAP code using 7.40 inline data declarations to call FM CVAPI_DOC_CHECKOUTVIEW

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 DOKAR FROM DRAW INTO @DATA(ld_pf_dokar).
 
 
 
DATA(ld_pf_std_url) = 'X'.
 
DATA(ld_pf_ext_call) = ' '.
 
"SELECT single DOKNR FROM DRAW INTO @DATA(ld_pf_doknr).
 
 
 
"SELECT single DOKVR FROM DRAW INTO @DATA(ld_pf_dokvr).
 
 
"SELECT single DOKTL FROM DRAW INTO @DATA(ld_pf_doktl).
 
"SELECT single RFCDEST FROM RFCDES INTO @DATA(ld_pf_ftp_dest).
DATA(ld_pf_ftp_dest) = ' '.
 
"SELECT single RFCDEST FROM RFCDES INTO @DATA(ld_pf_http_dest).
DATA(ld_pf_http_dest) = ' '.
 
"SELECT single NTADR FROM TDWD INTO @DATA(ld_pf_hostname).
DATA(ld_pf_hostname) = ' '.
 
"SELECT single CONTENT_PROVIDE FROM MCDOK INTO @DATA(ld_pf_content_provide).
DATA(ld_pf_content_provide) = ' '.
 
 


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!