SAP SO_ARC Function Module for Archiving objects









SO_ARC is a standard so arc SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Archiving objects 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 so arc FM, simply by entering the name SO_ARC into the relevant SAP transaction such as SE37 or SE38.

Function Group: SOIL
Program Name: SAPLSOIL
Main Program:
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function SO_ARC 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 'SO_ARC'"Archiving objects
EXPORTING
* FOLDER_ID = ' ' "Folder ID
FOLDER_REGION = "Function to be executed
* FUNCTION = 'DISP' "Function to be executed
OBJECT_FL_DISPLAY = "Folder-related definition data
OBJECT_HD_DISPLAY = "General header data
OBJECT_ID = "Object identifier of Office object
OWNER = "User responsible

IMPORTING
CHANGE_FLAG = "Flag: Object was changed
NEXT_ACTIVITY = "A function to be executed by SAPoffice
REPEAT_FLAG = "Flag: Repeat

TABLES
OBJCONT = "Contents of an object
OBJHEAD = "Object-specific header
OBJPARA = "Parameter block for transaction/report
OBJPARB = "Parameter block for function/dialog module

EXCEPTIONS
FUNCTION_NOT_AVAILABLE = 1
.



IMPORTING Parameters details for SO_ARC

FOLDER_ID - Folder ID

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

FOLDER_REGION - Function to be executed

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

FUNCTION - Function to be executed

Data type: SY-UCOMM
Default: 'DISP'
Optional: Yes
Call by Reference: No ( called with pass by value option)

OBJECT_FL_DISPLAY - Folder-related definition data

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

OBJECT_HD_DISPLAY - General header data

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

OBJECT_ID - Object identifier of Office object

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

OWNER - User responsible

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

EXPORTING Parameters details for SO_ARC

CHANGE_FLAG - Flag: Object was changed

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

NEXT_ACTIVITY - A function to be executed by SAPoffice

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

REPEAT_FLAG - Flag: Repeat

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

TABLES Parameters details for SO_ARC

OBJCONT - Contents of an object

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

OBJHEAD - Object-specific header

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

OBJPARA - Parameter block for transaction/report

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

OBJPARB - Parameter block for function/dialog module

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

EXCEPTIONS details

FUNCTION_NOT_AVAILABLE - Function is not active

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

Copy and paste ABAP code example for SO_ARC 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:
lt_objcont  TYPE STANDARD TABLE OF SOLI, "   
lv_folder_id  TYPE SOODK, "   SPACE
lv_change_flag  TYPE SONV-FLAG, "   
lv_function_not_available  TYPE SONV, "   
lt_objhead  TYPE STANDARD TABLE OF SOLI, "   
lv_folder_region  TYPE SOFH-FOLRG, "   
lv_next_activity  TYPE SY-UCOMM, "   
lt_objpara  TYPE STANDARD TABLE OF SELC, "   
lv_function  TYPE SY-UCOMM, "   'DISP'
lv_repeat_flag  TYPE SONV-FLAG, "   
lt_objparb  TYPE STANDARD TABLE OF SOOP1, "   
lv_object_fl_display  TYPE SOFM2, "   
lv_object_hd_display  TYPE SOOD2, "   
lv_object_id  TYPE SOODK, "   
lv_owner  TYPE SOUD-USRNAM. "   

  CALL FUNCTION 'SO_ARC'  "Archiving objects
    EXPORTING
         FOLDER_ID = lv_folder_id
         FOLDER_REGION = lv_folder_region
         FUNCTION = lv_function
         OBJECT_FL_DISPLAY = lv_object_fl_display
         OBJECT_HD_DISPLAY = lv_object_hd_display
         OBJECT_ID = lv_object_id
         OWNER = lv_owner
    IMPORTING
         CHANGE_FLAG = lv_change_flag
         NEXT_ACTIVITY = lv_next_activity
         REPEAT_FLAG = lv_repeat_flag
    TABLES
         OBJCONT = lt_objcont
         OBJHEAD = lt_objhead
         OBJPARA = lt_objpara
         OBJPARB = lt_objparb
    EXCEPTIONS
        FUNCTION_NOT_AVAILABLE = 1
. " SO_ARC




ABAP code using 7.40 inline data declarations to call FM SO_ARC

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_folder_id) = ' '.
 
"SELECT single FLAG FROM SONV INTO @DATA(ld_change_flag).
 
 
 
"SELECT single FOLRG FROM SOFH INTO @DATA(ld_folder_region).
 
"SELECT single UCOMM FROM SY INTO @DATA(ld_next_activity).
 
 
"SELECT single UCOMM FROM SY INTO @DATA(ld_function).
DATA(ld_function) = 'DISP'.
 
"SELECT single FLAG FROM SONV INTO @DATA(ld_repeat_flag).
 
 
 
 
 
"SELECT single USRNAM FROM SOUD INTO @DATA(ld_owner).
 


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!