SO_DOCUMENT_LINK SAP Function module - SAPoffice: Create link / reference to a document

SO_DOCUMENT_LINK is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name SO_DOCUMENT_LINK into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SOB3
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM SO_DOCUMENT_LINK - SO DOCUMENT LINK

CALL FUNCTION 'SO_DOCUMENT_LINK' "SAPoffice: Create link / reference to a document
  EXPORTING
*   forwarder = SPACE           " soud-usrnam   Forwarder: Name
    new_parent =                " soodk         ID of target folder
    object_id =                 " soodk         Object ID
    old_parent =                " soodk         ID of source folder
*   owner = SPACE               " soud-usrnam   Owner of object
  EXCEPTIONS
    NEW_FOLDER_NOT_EXIST = 1    "               The new folder does not exist
    OBJECT_ALREADY_IN_FOLDER = 2  "
    OBJECT_NOT_EXIST = 3        "               Object does not exist
    OLD_FOLDER_NOT_EXIST = 4    "               The old folder does not exist
    FOLDER_NO_AUTHORIZATION = 5  "              No authorization for this folder
    OPERATION_NO_AUTHORIZATION = 6  "           No authorization for this operation
    PARAMETER_ERROR = 7         "               Parameter error
    X_ERROR = 8                 "               Internal error
    .  "  SO_DOCUMENT_LINK

ABAP code example for Function Module SO_DOCUMENT_LINK

The ABAP code below is a full code listing to execute function module SO_DOCUMENT_LINK including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

 

SELECT single USRNAM 
  FROM SOUD 
  INTO @DATA(ld_forwarder).


DATA(ld_new_parent) = 'Check type of data required'.

DATA(ld_object_id) = 'Check type of data required'.

DATA(ld_old_parent) = 'Check type of data required'.
 

SELECT single USRNAM 
  FROM SOUD 
  INTO @DATA(ld_owner).

.

CALL FUNCTION 'SO_DOCUMENT_LINK'
  EXPORTING
*   forwarder =                  ld_forwarder
    new_parent =                 ld_new_parent
    object_id =                  ld_object_id
    old_parent =                 ld_old_parent
*   owner =                      ld_owner
  EXCEPTIONS
    NEW_FOLDER_NOT_EXIST =       1
    OBJECT_ALREADY_IN_FOLDER =    2
    OBJECT_NOT_EXIST =           3
    OLD_FOLDER_NOT_EXIST =       4
    FOLDER_NO_AUTHORIZATION =    5
    OPERATION_NO_AUTHORIZATION =    6
    PARAMETER_ERROR =            7
    X_ERROR =                    8
    .  "  SO_DOCUMENT_LINK

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 4. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 5. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 6. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 7. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 8. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_forwarder
 
 TYPE SOUD-USRNAM ,
ld_new_parent
 
 TYPE SOODK ,
ld_object_id
 
 TYPE SOODK ,
ld_old_parent
 
 TYPE SOODK ,
ld_owner
 
 TYPE SOUD-USRNAM .



SELECT single USRNAM 
  FROM SOUD 
  INTO ld_forwarder.

ld_new_parent = 'Check type of data required'.
ld_object_id = 'Check type of data required'.
ld_old_parent = 'Check type of data required'.

SELECT single USRNAM 
  FROM SOUD 
  INTO ld_owner.