SAP ARCHIV_PROCESS_OFFICE_INPUT Function Module for Archiving of Office documents









ARCHIV_PROCESS_OFFICE_INPUT is a standard archiv process office input 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 of Office documents 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 archiv process office input FM, simply by entering the name ARCHIV_PROCESS_OFFICE_INPUT into the relevant SAP transaction such as SE37 or SE38.

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



Function ARCHIV_PROCESS_OFFICE_INPUT 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 'ARCHIV_PROCESS_OFFICE_INPUT'"Archiving of Office documents
EXPORTING
* TABLEENTRY = ' ' "
* BINARC_LENGTH = "
* VSCAN_PROFILE = '/SCMS/KPRO_CREATE' "
* OFFICEPATH = ' ' "
DOCUMENT_TYPE = "
* AR_OBJECT = ' ' "
* DIALOG = 'X' "
ARCHIVOBJECT_LENGTH = "
* NOTE = ' ' "
* ORGOBJECT = ' ' "
* LATE = '-' "

TABLES
ARCHIVOBJECT = "
* BINARCHIVOBJECT = "

EXCEPTIONS
ERROR_ARCHIV = 1 ERROR_COMMUNICATIONTABLE = 2 ERROR_KERNEL = 3 ERROR_PARAMETER = 4 USER_EXIT = 5 NO_WORKITEM_CREATED = 6 ERROR_UPLOAD = 7 OTHERS = 8 BLOCKED_BY_POLICY = 9
.



IMPORTING Parameters details for ARCHIV_PROCESS_OFFICE_INPUT

TABLEENTRY -

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

BINARC_LENGTH -

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

VSCAN_PROFILE -

Data type: VSCAN_PROFILE
Default: '/SCMS/KPRO_CREATE'
Optional: Yes
Call by Reference: No ( called with pass by value option)

OFFICEPATH -

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

DOCUMENT_TYPE -

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

AR_OBJECT -

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

DIALOG -

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

ARCHIVOBJECT_LENGTH -

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

NOTE -

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

ORGOBJECT -

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

LATE -

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

TABLES Parameters details for ARCHIV_PROCESS_OFFICE_INPUT

ARCHIVOBJECT -

Data type: DOCS
Optional: No
Call by Reference: Yes

BINARCHIVOBJECT -

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

EXCEPTIONS details

ERROR_ARCHIV -

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

ERROR_COMMUNICATIONTABLE -

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

ERROR_KERNEL -

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

ERROR_PARAMETER -

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

USER_EXIT -

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

NO_WORKITEM_CREATED -

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

ERROR_UPLOAD -

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

OTHERS -

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

BLOCKED_BY_POLICY -

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for ARCHIV_PROCESS_OFFICE_INPUT 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_tableentry  TYPE TOAOM-AR_STATUS, "   SPACE
lt_archivobject  TYPE STANDARD TABLE OF DOCS, "   
lv_error_archiv  TYPE DOCS, "   
lv_binarc_length  TYPE SAPB-LENGTH, "   
lv_vscan_profile  TYPE VSCAN_PROFILE, "   '/SCMS/KPRO_CREATE'
lv_officepath  TYPE SAPB-SAPPFAD, "   SPACE
lt_binarchivobject  TYPE STANDARD TABLE OF TBL1024, "   
lv_error_communicationtable  TYPE TBL1024, "   
lv_error_kernel  TYPE TBL1024, "   
lv_document_type  TYPE TOADV-DOC_TYPE, "   
lv_ar_object  TYPE TOAV0-AR_OBJECT, "   SPACE
lv_error_parameter  TYPE TOAV0, "   
lv_dialog  TYPE TOAOM-AR_STATUS, "   'X'
lv_user_exit  TYPE TOAOM, "   
lv_archivobject_length  TYPE SAPB-LENGTH, "   
lv_no_workitem_created  TYPE SAPB, "   
lv_note  TYPE OACONF-NOTE, "   SPACE
lv_error_upload  TYPE OACONF, "   
lv_others  TYPE OACONF, "   
lv_orgobject  TYPE SWHACTOR, "   SPACE
lv_late  TYPE SY-INPUT, "   '-'
lv_blocked_by_policy  TYPE SY. "   

  CALL FUNCTION 'ARCHIV_PROCESS_OFFICE_INPUT'  "Archiving of Office documents
    EXPORTING
         TABLEENTRY = lv_tableentry
         BINARC_LENGTH = lv_binarc_length
         VSCAN_PROFILE = lv_vscan_profile
         OFFICEPATH = lv_officepath
         DOCUMENT_TYPE = lv_document_type
         AR_OBJECT = lv_ar_object
         DIALOG = lv_dialog
         ARCHIVOBJECT_LENGTH = lv_archivobject_length
         NOTE = lv_note
         ORGOBJECT = lv_orgobject
         LATE = lv_late
    TABLES
         ARCHIVOBJECT = lt_archivobject
         BINARCHIVOBJECT = lt_binarchivobject
    EXCEPTIONS
        ERROR_ARCHIV = 1
        ERROR_COMMUNICATIONTABLE = 2
        ERROR_KERNEL = 3
        ERROR_PARAMETER = 4
        USER_EXIT = 5
        NO_WORKITEM_CREATED = 6
        ERROR_UPLOAD = 7
        OTHERS = 8
        BLOCKED_BY_POLICY = 9
. " ARCHIV_PROCESS_OFFICE_INPUT




ABAP code using 7.40 inline data declarations to call FM ARCHIV_PROCESS_OFFICE_INPUT

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.

"SELECT single AR_STATUS FROM TOAOM INTO @DATA(ld_tableentry).
DATA(ld_tableentry) = ' '.
 
 
 
"SELECT single LENGTH FROM SAPB INTO @DATA(ld_binarc_length).
 
DATA(ld_vscan_profile) = '/SCMS/KPRO_CREATE'.
 
"SELECT single SAPPFAD FROM SAPB INTO @DATA(ld_officepath).
DATA(ld_officepath) = ' '.
 
 
 
 
"SELECT single DOC_TYPE FROM TOADV INTO @DATA(ld_document_type).
 
"SELECT single AR_OBJECT FROM TOAV0 INTO @DATA(ld_ar_object).
DATA(ld_ar_object) = ' '.
 
 
"SELECT single AR_STATUS FROM TOAOM INTO @DATA(ld_dialog).
DATA(ld_dialog) = 'X'.
 
 
"SELECT single LENGTH FROM SAPB INTO @DATA(ld_archivobject_length).
 
 
"SELECT single NOTE FROM OACONF INTO @DATA(ld_note).
DATA(ld_note) = ' '.
 
 
 
DATA(ld_orgobject) = ' '.
 
"SELECT single INPUT FROM SY INTO @DATA(ld_late).
DATA(ld_late) = '-'.
 
 


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!