SAP /AIN/DM_DOC_STA_READ Function Module for Read documents status from the database









/AIN/DM_DOC_STA_READ is a standard /ain/dm doc sta read SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read documents status from the database 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 /ain/dm doc sta read FM, simply by entering the name /AIN/DM_DOC_STA_READ into the relevant SAP transaction such as SE37 or SE38.

Function Group: /AIN/DM_DOC
Program Name: /AIN/SAPLDM_DOC
Main Program: /AIN/SAPLDM_DOC
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function /AIN/DM_DOC_STA_READ 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 '/AIN/DM_DOC_STA_READ'"Read documents status from the database
EXPORTING
IV_DOC_GUID = "Document GUID
IV_ACTION_TYPE = "Action type

IMPORTING
EV_STATUS = "Document status
EV_REASON_CODE = "Reason code

EXCEPTIONS
DOCUMENT_GUID_IS_INITIAL = 1 OBJECT_NOT_FOUND = 2 OPEN_SQL_ERROR = 3
.



IMPORTING Parameters details for /AIN/DM_DOC_STA_READ

IV_DOC_GUID - Document GUID

Data type: /AIN/DM_DOC_GUID
Optional: No
Call by Reference: Yes

IV_ACTION_TYPE - Action type

Data type: /AIN/DM_ACTION_TYPE
Optional: No
Call by Reference: Yes

EXPORTING Parameters details for /AIN/DM_DOC_STA_READ

EV_STATUS - Document status

Data type: /AIN/DM_DOC_STATUS
Optional: No
Call by Reference: Yes

EV_REASON_CODE - Reason code

Data type: /AIN/DM_REASON_CODE
Optional: No
Call by Reference: Yes

EXCEPTIONS details

DOCUMENT_GUID_IS_INITIAL - Key field for the document guid is initial

Data type:
Optional: No
Call by Reference: Yes

OBJECT_NOT_FOUND - Object does not exist in the database

Data type:
Optional: No
Call by Reference: Yes

OPEN_SQL_ERROR - An Open SQL exception occurred

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for /AIN/DM_DOC_STA_READ 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_ev_status  TYPE /AIN/DM_DOC_STATUS, "   
lv_iv_doc_guid  TYPE /AIN/DM_DOC_GUID, "   
lv_document_guid_is_initial  TYPE /AIN/DM_DOC_GUID, "   
lv_ev_reason_code  TYPE /AIN/DM_REASON_CODE, "   
lv_iv_action_type  TYPE /AIN/DM_ACTION_TYPE, "   
lv_object_not_found  TYPE /AIN/DM_ACTION_TYPE, "   
lv_open_sql_error  TYPE /AIN/DM_ACTION_TYPE. "   

  CALL FUNCTION '/AIN/DM_DOC_STA_READ'  "Read documents status from the database
    EXPORTING
         IV_DOC_GUID = lv_iv_doc_guid
         IV_ACTION_TYPE = lv_iv_action_type
    IMPORTING
         EV_STATUS = lv_ev_status
         EV_REASON_CODE = lv_ev_reason_code
    EXCEPTIONS
        DOCUMENT_GUID_IS_INITIAL = 1
        OBJECT_NOT_FOUND = 2
        OPEN_SQL_ERROR = 3
. " /AIN/DM_DOC_STA_READ




ABAP code using 7.40 inline data declarations to call FM /AIN/DM_DOC_STA_READ

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.

 
 
 
 
 
 
 


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!