SAP CVAPI_DOC_DIALOG Function Module for NOTRANSL: DMS APIs









CVAPI_DOC_DIALOG is a standard cvapi doc dialog 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: DMS APIs 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 dialog FM, simply by entering the name CVAPI_DOC_DIALOG 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_DIALOG 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_DIALOG'"NOTRANSL: DMS APIs
  EXPORTING
*  PF_SKIP_FIRST = 'X' "Überspringe Einstiegsbild
*  PF_NO_CHANGE_TRANS_FLD = ' ' "Keine Änderung der übergebenen Daten (DRAW)
*  PF_NOT_DEQUEUE_ALL = ' ' "Nicht alle Sperren aufheben
*  PF_NO_CHANGE = ' ' "Funcion Ändern nicht erlaubt
*  PF_NO_CREATE = ' ' "Funcion Änlegen nicht erlaubt
   PF_TCODE =  "Transaktion
*  PF_COMMIT = ' ' "Commitkennzeichen
*  PF_DOKAR =  "Dokumentart
*  PF_DOKNR =  "Dokumentnummer
*  PF_DOKVR =  "Dokumentversion
*  PF_DOKTL =  "Teildokument
*  PS_DRAW =  "Dokumentdaten (Import)
*  PS_API_CONTROL =  "API-Steuerung

 IMPORTING
   PSX_DRAW =  "Dokumentdaten (Export)
   PFX_UPDATE_FLAG =  "Dokument wurde geändert

TABLES
*  PT_DRAT_X =  "Kurztexte (Import/Export)
*  PT_DRAD_X =  "Objektverknüpfungen (Import/Export)
*  PT_FILES_X =  "Originale eines Dokumentes
*  PT_COMP_X =  "Zusatzdateien (Import/Export)

EXCEPTIONS
   NOT_FOUND = 1    NO_AUTH = 2    LOCKED = 3    ERROR = 4    TCODE_ERROR = 5
.



IMPORTING Parameters details for CVAPI_DOC_DIALOG

PF_SKIP_FIRST - Überspringe Einstiegsbild

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

PF_NO_CHANGE_TRANS_FLD - Keine Änderung der übergebenen Daten (DRAW)

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

PF_NOT_DEQUEUE_ALL - Nicht alle Sperren aufheben

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

PF_NO_CHANGE - Funcion Ändern nicht erlaubt

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

PF_NO_CREATE - Funcion Änlegen nicht erlaubt

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

PF_TCODE - Transaktion

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

PF_COMMIT - Commitkennzeichen

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

PF_DOKAR - Dokumentart

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

PF_DOKNR - Dokumentnummer

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

PF_DOKVR - Dokumentversion

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

PF_DOKTL - Teildokument

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

PS_DRAW - Dokumentdaten (Import)

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

PS_API_CONTROL - API-Steuerung

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

EXPORTING Parameters details for CVAPI_DOC_DIALOG

PSX_DRAW - Dokumentdaten (Export)

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

PFX_UPDATE_FLAG - Dokument wurde geändert

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

TABLES Parameters details for CVAPI_DOC_DIALOG

PT_DRAT_X - Kurztexte (Import/Export)

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

PT_DRAD_X - Objektverknüpfungen (Import/Export)

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

PT_FILES_X - Originale eines Dokumentes

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

PT_COMP_X - Zusatzdateien (Import/Export)

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

EXCEPTIONS details

NOT_FOUND - Dokument nicht vorhanden

Data type:
Optional: No
Call by Reference: Yes

NO_AUTH - Keine Berechtigung

Data type:
Optional: No
Call by Reference: Yes

LOCKED - Dokument gesperrt

Data type:
Optional: No
Call by Reference: Yes

ERROR - allg. Fehler

Data type:
Optional: No
Call by Reference: Yes

TCODE_ERROR - Tcode not allowed

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for CVAPI_DOC_DIALOG 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_psx_draw  TYPE DRAW, "   
lv_not_found  TYPE DRAW, "   
lt_pt_drat_x  TYPE STANDARD TABLE OF DMS_DB_DRAT, "   
lv_pf_skip_first  TYPE XFELD, "   'X'
lv_pf_no_change_trans_fld  TYPE XFELD, "   SPACE
lv_pf_not_dequeue_all  TYPE XFELD, "   SPACE
lv_pf_no_change  TYPE XFELD, "   SPACE
lv_pf_no_create  TYPE XFELD, "   SPACE
lv_no_auth  TYPE XFELD, "   
lv_pf_tcode  TYPE SYST-TCODE, "   
lt_pt_drad_x  TYPE STANDARD TABLE OF DMS_DB_DRAD, "   
lv_pfx_update_flag  TYPE XFELD, "   
lv_locked  TYPE XFELD, "   
lv_pf_commit  TYPE XFELD, "   SPACE
lt_pt_files_x  TYPE STANDARD TABLE OF CVAPI_DOC_FILE, "   
lv_error  TYPE CVAPI_DOC_FILE, "   
lv_pf_dokar  TYPE DRAW-DOKAR, "   
lt_pt_comp_x  TYPE STANDARD TABLE OF CVAPI_DOC_COMP, "   
lv_pf_doknr  TYPE DRAW-DOKNR, "   
lv_tcode_error  TYPE DRAW, "   
lv_pf_dokvr  TYPE DRAW-DOKVR, "   
lv_pf_doktl  TYPE DRAW-DOKTL, "   
lv_ps_draw  TYPE DRAW, "   
lv_ps_api_control  TYPE CVAPI_API_CONTROL. "   

  CALL FUNCTION 'CVAPI_DOC_DIALOG'  "NOTRANSL: DMS APIs
    EXPORTING
         PF_SKIP_FIRST = lv_pf_skip_first
         PF_NO_CHANGE_TRANS_FLD = lv_pf_no_change_trans_fld
         PF_NOT_DEQUEUE_ALL = lv_pf_not_dequeue_all
         PF_NO_CHANGE = lv_pf_no_change
         PF_NO_CREATE = lv_pf_no_create
         PF_TCODE = lv_pf_tcode
         PF_COMMIT = lv_pf_commit
         PF_DOKAR = lv_pf_dokar
         PF_DOKNR = lv_pf_doknr
         PF_DOKVR = lv_pf_dokvr
         PF_DOKTL = lv_pf_doktl
         PS_DRAW = lv_ps_draw
         PS_API_CONTROL = lv_ps_api_control
    IMPORTING
         PSX_DRAW = lv_psx_draw
         PFX_UPDATE_FLAG = lv_pfx_update_flag
    TABLES
         PT_DRAT_X = lt_pt_drat_x
         PT_DRAD_X = lt_pt_drad_x
         PT_FILES_X = lt_pt_files_x
         PT_COMP_X = lt_pt_comp_x
    EXCEPTIONS
        NOT_FOUND = 1
        NO_AUTH = 2
        LOCKED = 3
        ERROR = 4
        TCODE_ERROR = 5
. " CVAPI_DOC_DIALOG




ABAP code using 7.40 inline data declarations to call FM CVAPI_DOC_DIALOG

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.

 
 
 
DATA(ld_pf_skip_first) = 'X'.
 
DATA(ld_pf_no_change_trans_fld) = ' '.
 
DATA(ld_pf_not_dequeue_all) = ' '.
 
DATA(ld_pf_no_change) = ' '.
 
DATA(ld_pf_no_create) = ' '.
 
 
"SELECT single TCODE FROM SYST INTO @DATA(ld_pf_tcode).
 
 
 
 
DATA(ld_pf_commit) = ' '.
 
 
 
"SELECT single DOKAR FROM DRAW INTO @DATA(ld_pf_dokar).
 
 
"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).
 
 
 


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!