SAP ABAP Class /SCMB/CL_DF_ARCHIVE (Archiving Document Flow)

Hierarchy

☛ PI_BASIS (Software Component) Basis Plug-In
   ⤷ SCM-BAS-DF (Application Component) Cross-System and Cross-Partner Document Flow
     ⤷ /SCMB/FLOW_NET (Package) Document Flow, Link

Properties

Class	/SCMB/CL_DF_ARCHIVE
Short Description	Archiving Document Flow
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/SCMB/FLOW_NET	Document Flow, Link
Created	20051215	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/SCMB/CL_DF_DOCFLOW	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	/SCMB/CL_DF_RELATION_TYPE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class /SCMB/CL_DF_ARCHIVE has no interface implemented.

Friends

Class /SCMB/CL_DF_ARCHIVE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ACCESS_MODE	Constant	Public	☐	See coding			Archive access mode (Read or Write)	20090324
2	GC_ARCH_CLASS	Constant	Public	☐	Type reference (TYPE)	ARCH_CLAS_	'/SCMB/DF'	DocFlow Archiving class name	20090324
3	GC_FALSE	Constant	Private	☐	Type reference (TYPE)	XFELD	SPACE	Boolean false	20090324
4	GC_STRUCTURE	Constant	Public	☐	Type reference (TYPE)	SEOCLSNAME	'/SCMB/DF_NODE_ARCHIVE_STR'	Document structure	20060106
5	GC_TRUE	Constant	Private	☐	Type reference (TYPE)	XFELD	'X'	Checkbox	20060110
6	GT_ARCH_INSTANCE	Static Attribute	Private	☐	See coding			Archive instance buffer table	20090324
7	GT_READ_BUFFER	Static Attribute	Private	☐	See coding			Read buffer for DocFlow data	20090324
8	GT_WRITE_BUFFER	Static Attribute	Private	☐	See coding			Write buffer for DocFlow keys	20090324
9	GV_IND	Static Attribute	Private	☐	Type reference (TYPE)	FLAG		Indicator for register table	20060110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ARCHIVE_OBJECT	Static method	Public	Method	ADK: Select and Buffer Keys of DocFlow Data to be Archived	20090324
2	CHECK_HANDLE	Static method	Private	Method	Check Validity of the Archive Handle for Chosen Access Mode	20090324
3	DELETE	Static method	Public	Method	ADK: Delete Document Flow Objects from Database	20090324
4	DELETE_FROM_DB	Static method	Public	Method	Delete Document Flow Objects from Database	20060109
5	FREE_DATA	Static method	Public	Method	ADK: Clear Archiving Class Buffers	20090324
6	GET_DATA	Static method	Public	Method	ADK: Supply DocFlow Node Data for Writing into Archive	20090324
7	GET_TABLE	Static method	Public	Method	ADK: Get DF Relevant Data of Specified Structure from Archiv	20090324
8	INIT_READ	Static method	Public	Method	ADK: Initialize Archiving Class for Reading Session	20090324
9	INIT_WRITE	Static method	Public	Method	ADK: Initialize Archiving Class for Write Session	20090324
10	PUT_DATA	Static method	Public	Method	ADK: Fill Read Buffers with Data Received from Archive (ADK)	20090324
11	READ_FROM_ARCHIVE	Static method	Public	Method	Reading Document Flow from Archive File	20060109
12	REGISTER_TABLES	Static method	Public	Method	Read Generated Tables of Document Flow	20051230
13	RELOAD	Static method	Public	Method	ADK: Reload DF Node Data from Archive into DB Tables	20090324
14	RENEW	Static method	Public	Method	ADK: Release Data Buffered of a Single Archiving Object	20090324
15	ROLLBACK_WORK	Static method	Public	Method	ADK: Rollback Results of Delete or Reload; Delete Buffers	20090324
16	WRITE_BY_DOC	Static method	Public	Method	Writing to Archive by Document	20051215

Events

Class /SCMB/CL_DF_ARCHIVE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_S_ARC_INSTANCE	Private	See coding		Archive instance structure (ADK compliant)	20090324	BEGIN OF typ_s_arc_instance, handle TYPE sytabix, accessmode TYPE c LENGTH 1, code_page TYPE tcp00-cpcodepage, number_format TYPE tcp00-cpcodepage, convert TYPE REF TO cl_abap_conv_in_ce, END OF typ_s_arc_instance
2	TYP_S_READ_BUFFER	Private	See coding		Archive read buffer for DF node data (ADK compliant)	20090324	BEGIN OF typ_s_read_buffer, handle TYPE sytabix, delflg TYPE arch_flags, data TYPE /scmb/df_node_archive_str, END OF typ_s_read_buffer
3	TYP_S_WRITE_BUFFER	Private	See coding		Archive write buffer for DF node keys (ADK compliant)	20090324	BEGIN OF typ_s_write_buffer, handle TYPE sytabix, df_guid TYPE /scmb/df_guid, df_category TYPE /scmb/df_category, delete_flag TYPE c LENGTH 1, END OF typ_s_write_buffer

Method Signatures

Method ARCHIVE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DOCUMENT	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENT_TBL		Document node selection information	20090324
2	Importing	IT_DOCUMENTX	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENTX_TBL		Document Flow: Document	20130211
3	Importing	IT_RELATION_TYPE	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_TYPE_TBL		Categories of SOBL links to be read	20090324
4	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archive file handle	20090324
5	Importing	IV_COMPLETENESS	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_COMPLETENESS	/SCMB/CL_DF_RELATION_TYPE=>GC_COMPLETE	Indicator: Read complete network	20090324
6	Importing	IV_DIRECTION	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DIRECTION		Network Read Direction	20090324
7	Importing	IV_OBJECT_DELETE_FLAG	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Delete indicator for ADK	20090324
8	Importing	IV_RELATION_BACKWARD	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	/SCMB/CL_DF_RELATION_TYPE=>GC_MAX_RELATION_CNT	Number of Links - backward	20090324
9	Importing	IV_RELATION_FORWARD	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	/SCMB/CL_DF_RELATION_TYPE=>GC_MAX_RELATION_CNT	Number of Links - forward	20090324

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20090324

Method CHECK_HANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACCESS_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		access mode indicator	20090324
2	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20090324

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archive Handle	20090324
2	Importing	IV_DELTST	Call by reference	☐	Type reference (TYPE)	BOOLE_D	SPACE	Delete = FALSE; Test = TRUE	20090324

Method DELETE on class /SCMB/CL_DF_ARCHIVE has no exception.

Method DELETE_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archive Handle	20060109

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20060112
2	/SCMB/CX_DF_ATTRIBUTE	☐	Belegfluss: Attributfehler	20060112
3	/SCMB/CX_DF_DOCUMENT	☐	Belegfluss: Belegfehler	20060112
4	/SCMB/CX_DF_RELATION	☐	Belegfluss: Verknüpfungsfehler	20060112

Method FREE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324

Method FREE_DATA on class /SCMB/CL_DF_ARCHIVE has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324

Method GET_DATA on class /SCMB/CL_DF_ARCHIVE has no exception.

Method GET_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Records of the chosen structure	20090324
2	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324
3	Importing	IV_RECORD_STRUCTURE	Call by reference	☐	Type reference (TYPE)	RKZ_DBNA		Structure of data to be read	20090324

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20090324

Method INIT_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324
2	Importing	IV_CODE_PAGE	Call by reference	☐	Type reference (TYPE)	TCP00-CPCODEPAGE		Codepage ID valid at file write time	20090324
3	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	SYDATUM		Date of file write	20090324
4	Importing	IV_NUMBER_FORMAT	Call by reference	☐	Type reference (TYPE)	TCP00-CPCODEPAGE		Number format valid at file write time	20090324
5	Importing	IV_RELEASE_NUMBER	Call by reference	☐	Type reference (TYPE)	SYSAPRL		SAP BASIS release number valid at file write time	20090324

Method INIT_READ on class /SCMB/CL_DF_ARCHIVE has no exception.

Method INIT_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324

Method INIT_WRITE on class /SCMB/CL_DF_ARCHIVE has no exception.

Method PUT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20090324

Method READ_FROM_ARCHIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archive handle	20060109

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20060112
2	/SCMB/CX_DF_DOCUMENT	☐	Document flow: Archiving error	20060112

Method REGISTER_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Internal Table, Current Line Index	20051230

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20060109

Method RELOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324
2	Importing	IV_TEST	Call by reference	☐	Type reference (TYPE)	BOOLE_D	SPACE	Test indicator	20090324

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20090731

Method RENEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324

Method RENEW on class /SCMB/CL_DF_ARCHIVE has no exception.

Method ROLLBACK_WORK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		archive file handle	20090324

Method ROLLBACK_WORK on class /SCMB/CL_DF_ARCHIVE has no exception.

Method WRITE_BY_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCUMENT	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENT		Document Flow: Document Identification	20051215
2	Importing	IT_DOCUMENT	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENT_TBL		Document Flow: Document	20051215
3	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Handle	20051215

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_ARCHIVE	☐	Document flow: Archiving error	20051230
2	/SCMB/CX_DF_ATTRIBUTE	☐	Belegfluss: Attributfehler	20060103
3	/SCMB/CX_DF_DOCUMENT	☐	Belegfluss: Belegfehler	20060103
4	/SCMB/CX_DF_RELATION	☐	Belegfluss: Verknüpfungsfehler	20060103

History

Last changed by/on	SAP	20130531
SAP Release Created in	2006_1_620