SOBL_ARCHIVE_OBJECT SAP Function module - Function Module to Note the Class Data

SOBL_ARCHIVE_OBJECT 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 SOBL_ARCHIVE_OBJECT into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SOBL_ARCHIVE
Released Date: 09.08.2002
Processing type: Normal fucntion module

Pattern for FM SOBL_ARCHIVE_OBJECT - SOBL ARCHIVE OBJECT

CALL FUNCTION 'SOBL_ARCHIVE_OBJECT' "Function Module to Note the Class Data
  EXPORTING
    archive_handle =            " sy-tabix      Handle
    root_object =               " sibflporb     LPOR of the Calling Business Object
*   root_logsys =               " logsys        Logical System
*   role_options =              " obl_t_rolt    OBL: Select Options for Role Type
*   relation_options =          " obl_t_relt    OBL: Select Options for Relationship Types
*   object_delete_flag = ' '    "               Deletion Indicator 'X' = Do Not Delete!
  EXCEPTIONS
    WRONG_ACCESS_TO_ARCHIVE = 1  "              Error in Accessing Archive
    CLASS_NOT_INITIALIZED = 2   "               Class Not Initialized
    .  "  SOBL_ARCHIVE_OBJECT

ABAP code example for Function Module SOBL_ARCHIVE_OBJECT

The ABAP code below is a full code listing to execute function module SOBL_ARCHIVE_OBJECT 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).

DATA(ld_archive_handle) = '123 '.

DATA(ld_root_object) = '123 '.

DATA(ld_root_logsys) = '123 '.

DATA(ld_role_options) = 'some text here'.

DATA(ld_relation_options) = 'some text here'.

DATA(ld_object_delete_flag) = 'some text here'.
.

CALL FUNCTION 'SOBL_ARCHIVE_OBJECT'
  EXPORTING
    archive_handle =             ld_archive_handle
    root_object =                ld_root_object
*   root_logsys =                ld_root_logsys
*   role_options =               ld_role_options
*   relation_options =           ld_relation_options
*   object_delete_flag =         ld_object_delete_flag
  EXCEPTIONS
    WRONG_ACCESS_TO_ARCHIVE =    1
    CLASS_NOT_INITIALIZED =      2
    .  "  SOBL_ARCHIVE_OBJECT

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
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_archive_handle
 
 TYPE SY-TABIX ,
ld_root_object
 
 TYPE SIBFLPORB ,
ld_root_logsys
 
 TYPE LOGSYS ,
ld_role_options
 
 TYPE OBL_T_ROLT ,
ld_relation_options
 
 TYPE OBL_T_RELT ,
ld_object_delete_flag
 
 TYPE STRING .


ld_archive_handle = '123 '.
ld_root_object = '123 '.
ld_root_logsys = '123 '.
ld_role_options = 'some text here'.
ld_relation_options = 'some text here'.
ld_object_delete_flag = 'some text here'.

SAP Documentation for FM SOBL_ARCHIVE_OBJECT