SAP ARCHIVOBJECT_CREATE_SYNCHRON Function Module for
ARCHIVOBJECT_CREATE_SYNCHRON is a standard archivobject create synchron SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 archivobject create synchron FM, simply by entering the name ARCHIVOBJECT_CREATE_SYNCHRON into the relevant SAP transaction such as SE37 or SE38.
Function Group: ARCHIVOBJECT
Program Name: SAPLARCHIVOBJECT
Main Program: SAPLARCHIVOBJECT
Appliation area: S
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:
Function ARCHIVOBJECT_CREATE_SYNCHRON 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 'ARCHIVOBJECT_CREATE_SYNCHRON'".
EXPORTING
* ARCHIV_DOC_ID = ' ' "ID of document to be archived
* EXTENSION = ' ' "Extension (no longer used)
* NO_ARC_DELETE = ' ' "If 'X' file will not be deleted from archive
* VSCAN_PROFILE = '/SCMS/KPRO_CREATE' "
* ARCHIV_ID = ' ' "ID of referenced archive
DOCUMENT_TYPE = "Document type (FAX,REO,OTF,ALF,...)
* NOTE = ' ' "
* PATH = ' ' "
* POOLINFO = ' ' "Archiving strategy
* SIGN = ' ' "Request ID
TARGETARCHIV_ID = "Target archive
* PTC = ' ' "If 'X', path will be checked
IMPORTING
ARCHIV_DOC_ID = "ID of document to be archived
RETURN_CODE = "
TABLES
* COMPONENTS = "
EXCEPTIONS
ERROR_ARCHIV = 1 ERROR_COMMUNICATIONTABLE = 2 ERROR_KERNEL = 3 BLOCKED_BY_POLICY = 4
IMPORTING Parameters details for ARCHIVOBJECT_CREATE_SYNCHRON
ARCHIV_DOC_ID - ID of document to be archived
Data type: SAPB-SAPADOKIDDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
EXTENSION - Extension (no longer used)
Data type: SAPB-SAPPFADDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
NO_ARC_DELETE - If 'X' file will not be deleted from archive
Data type: TOAOM-AR_STATUSDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
VSCAN_PROFILE -
Data type: VSCAN_PROFILEDefault: '/SCMS/KPRO_CREATE'
Optional: Yes
Call by Reference: No ( called with pass by value option)
ARCHIV_ID - ID of referenced archive
Data type: TOAAR-ARCHIV_IDDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
DOCUMENT_TYPE - Document type (FAX,REO,OTF,ALF,...)
Data type: SAPB-SAPDOKTYPOptional: No
Call by Reference: No ( called with pass by value option)
NOTE -
Data type: SAPB-SAPNOTIZDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
PATH -
Data type: SAPB-SAPPFADDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
POOLINFO - Archiving strategy
Data type: SAPB-SAPPOOLINFDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
SIGN - Request ID
Data type: SAPB-SAPBZZDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
TARGETARCHIV_ID - Target archive
Data type: TOAAR-ARCHIV_IDOptional: No
Call by Reference: No ( called with pass by value option)
PTC - If 'X', path will be checked
Data type: TOAOM-AR_STATUSDefault: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)
EXPORTING Parameters details for ARCHIVOBJECT_CREATE_SYNCHRON
ARCHIV_DOC_ID - ID of document to be archived
Data type: SAPB-SAPADOKIDOptional: No
Call by Reference: No ( called with pass by value option)
RETURN_CODE -
Data type: SAPB-SAPRETURNCOptional: No
Call by Reference: No ( called with pass by value option)
TABLES Parameters details for ARCHIVOBJECT_CREATE_SYNCHRON
COMPONENTS -
Data type: HTTP_COMPOptional: Yes
Call by Reference: No ( called with pass by value option)
EXCEPTIONS details
ERROR_ARCHIV - Archive system error
Data type:Optional: No
Call by Reference: No ( called with pass by value option)
ERROR_COMMUNICATIONTABLE - Archive table error (customizing archives)
Data type:Optional: No
Call by Reference: No ( called with pass by value option)
ERROR_KERNEL - SAP kernel error
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 ARCHIVOBJECT_CREATE_SYNCHRON 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_components | TYPE STANDARD TABLE OF HTTP_COMP, " | |||
| lv_error_archiv | TYPE HTTP_COMP, " | |||
| lv_archiv_doc_id | TYPE SAPB-SAPADOKID, " | |||
| lv_archiv_doc_id | TYPE SAPB-SAPADOKID, " SPACE | |||
| lv_extension | TYPE SAPB-SAPPFAD, " SPACE | |||
| lv_no_arc_delete | TYPE TOAOM-AR_STATUS, " SPACE | |||
| lv_vscan_profile | TYPE VSCAN_PROFILE, " '/SCMS/KPRO_CREATE' | |||
| lv_archiv_id | TYPE TOAAR-ARCHIV_ID, " SPACE | |||
| lv_return_code | TYPE SAPB-SAPRETURNC, " | |||
| lv_error_communicationtable | TYPE SAPB, " | |||
| lv_error_kernel | TYPE SAPB, " | |||
| lv_document_type | TYPE SAPB-SAPDOKTYP, " | |||
| lv_note | TYPE SAPB-SAPNOTIZ, " SPACE | |||
| lv_blocked_by_policy | TYPE SAPB, " | |||
| lv_path | TYPE SAPB-SAPPFAD, " SPACE | |||
| lv_poolinfo | TYPE SAPB-SAPPOOLINF, " SPACE | |||
| lv_sign | TYPE SAPB-SAPBZZ, " SPACE | |||
| lv_targetarchiv_id | TYPE TOAAR-ARCHIV_ID, " | |||
| lv_ptc | TYPE TOAOM-AR_STATUS. " SPACE |
| CALL FUNCTION 'ARCHIVOBJECT_CREATE_SYNCHRON' " |
| EXPORTING | ||
| ARCHIV_DOC_ID | = lv_archiv_doc_id | |
| EXTENSION | = lv_extension | |
| NO_ARC_DELETE | = lv_no_arc_delete | |
| VSCAN_PROFILE | = lv_vscan_profile | |
| ARCHIV_ID | = lv_archiv_id | |
| DOCUMENT_TYPE | = lv_document_type | |
| NOTE | = lv_note | |
| PATH | = lv_path | |
| POOLINFO | = lv_poolinfo | |
| SIGN | = lv_sign | |
| TARGETARCHIV_ID | = lv_targetarchiv_id | |
| PTC | = lv_ptc | |
| IMPORTING | ||
| ARCHIV_DOC_ID | = lv_archiv_doc_id | |
| RETURN_CODE | = lv_return_code | |
| TABLES | ||
| COMPONENTS | = lt_components | |
| EXCEPTIONS | ||
| ERROR_ARCHIV = 1 | ||
| ERROR_COMMUNICATIONTABLE = 2 | ||
| ERROR_KERNEL = 3 | ||
| BLOCKED_BY_POLICY = 4 | ||
| . " ARCHIVOBJECT_CREATE_SYNCHRON | ||
ABAP code using 7.40 inline data declarations to call FM ARCHIVOBJECT_CREATE_SYNCHRON
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 SAPADOKID FROM SAPB INTO @DATA(ld_archiv_doc_id). | ||||
| "SELECT single SAPADOKID FROM SAPB INTO @DATA(ld_archiv_doc_id). | ||||
| DATA(ld_archiv_doc_id) | = ' '. | |||
| "SELECT single SAPPFAD FROM SAPB INTO @DATA(ld_extension). | ||||
| DATA(ld_extension) | = ' '. | |||
| "SELECT single AR_STATUS FROM TOAOM INTO @DATA(ld_no_arc_delete). | ||||
| DATA(ld_no_arc_delete) | = ' '. | |||
| DATA(ld_vscan_profile) | = '/SCMS/KPRO_CREATE'. | |||
| "SELECT single ARCHIV_ID FROM TOAAR INTO @DATA(ld_archiv_id). | ||||
| DATA(ld_archiv_id) | = ' '. | |||
| "SELECT single SAPRETURNC FROM SAPB INTO @DATA(ld_return_code). | ||||
| "SELECT single SAPDOKTYP FROM SAPB INTO @DATA(ld_document_type). | ||||
| "SELECT single SAPNOTIZ FROM SAPB INTO @DATA(ld_note). | ||||
| DATA(ld_note) | = ' '. | |||
| "SELECT single SAPPFAD FROM SAPB INTO @DATA(ld_path). | ||||
| DATA(ld_path) | = ' '. | |||
| "SELECT single SAPPOOLINF FROM SAPB INTO @DATA(ld_poolinfo). | ||||
| DATA(ld_poolinfo) | = ' '. | |||
| "SELECT single SAPBZZ FROM SAPB INTO @DATA(ld_sign). | ||||
| DATA(ld_sign) | = ' '. | |||
| "SELECT single ARCHIV_ID FROM TOAAR INTO @DATA(ld_targetarchiv_id). | ||||
| "SELECT single AR_STATUS FROM TOAOM INTO @DATA(ld_ptc). | ||||
| DATA(ld_ptc) | = ' '. | |||
Search for further information about these or an SAP related objects