SAP ABAP Class CL_SRM_KPRO_ARCHIVE (Archiving of Documents/Records)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_GSP_ARCHIVE (Package) Archiving for Generic SP

Properties

Class	CL_SRM_KPRO_ARCHIVE
Short Description	Archiving of Documents/Records
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SRM_GSP_ARCHIVE	Archiving for Generic SP
Created	20040830	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SCMST	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	SRMGS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SRM_KPRO_ARCHIVE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SRM_GSP_HELPER	☐	20050128	Help Class for Archiving Support

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MY_AREA_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Area ID	20041015
2	MY_CLIENTSERVICE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_SRM_SRM_CLIENT_SERVICE		Interface for Client-Specific Service Functions	20041015
3	MY_RMS_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Records Managment System ID	20041015
4	MY_SPS_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Element Type ID	20041015

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_POID_TAB_FLAG	Static method	Private	Method	Change the Archiving Flags in the POID Directory	20041214
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20041015
3	DELETE_DOCUMENTS	Instance method	Public	Method	Deletes all archived documents from the database	20041011
4	DELETE_DOCUMENT_FROM_DB	Static method	Public	Method	An archived documents is deleted from the database	20041008
5	GET_CLIENT_SERVICE	Static method	Private	Method	Gets Reference to Client Service	20041015
6	GET_INSTANCE_POID	Static method	Private	Method	Gets Instance POID of a Document	20041015
7	GET_POID_DIR_TAB	Static method	Private	Method	Gets name of table where POID directory is stored	20041014
8	GET_POID_TAB_FLAG	Static method	Private	Method	Archiving Flag Queries in the POID Directory	20041214
9	GET_RETENTION_DATE	Static method	Private	Method	Calculates the retention date	20041014
10	GET_RMS_ID	Instance method	Public	Method	Get the RMS ID	20041018
11	GET_SPS_ID	Instance method	Public	Method	Get the SPS ID	20041018
12	IS_DOCUMENT_ARCHIVABLE	Static method	Private	Method	Tests whether archiving is forbidden by standard attribute	20041220
13	MARK_DOCUMENTS	Instance method	Public	Method	Searches archivable documents and sets flag in POID directry	20040830
14	RELOCATE_DOCUMENTS	Instance method	Public	Method	Relocates content of documents to specified repository	20041207
15	SET_RMS_ID	Instance method	Public	Method	Set the RMS ID	20041018
16	SET_SPS_ID	Instance method	Public	Method	Set SPS ID	20041018
17	WRITE_DOCUMENTS	Instance method	Public	Method	Writes all tagged documents into archive	20041012
18	WRITE_DOCUMENT_INTO_ARCHIVE	Static method	Public	Method	Writes a specified document to the archive	20041006

Events

Class CL_SRM_KPRO_ARCHIVE has no event.

Types

Class CL_SRM_KPRO_ARCHIVE has no local type.

Method Signatures

Method CHANGE_POID_TAB_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_ID		LOIO-ID	20041214
2	Importing	RMS_ID	Call by reference	☑	Type reference (TYPE)	STRING		RMS_ID	20041214
3	Importing	SPS_ID	Call by reference	☑	Type reference (TYPE)	STRING		Elemenart-ID	20041214
4	Importing	STATUS	Call by reference	☐	Type reference (TYPE)	C		Archivierungsstatus ('T'=makiert; 'A' = archiviert)	20041214

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041214

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RMS_ID	Call by reference	☑	Type reference (TYPE)	STRING		RMS ID	20041015
2	Importing	SPS_ID	Call by reference	☑	Type reference (TYPE)	STRING		SPS ID	20041015

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041214

Method DELETE_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ARC_OBJ	Call by reference	☐	Type reference (TYPE)	ARCH_OBJ-OBJECT		Name of Archiving Object	20041011
2	Importing	DELETE_TESTMODE	Call by reference	☐	Type reference (TYPE)	C			20041011
3	Changing	DOCUMENTS_TAB	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Tabelle mit IDs von erfolgreich gelöschten Dokumenten	20041209
4	Changing	FAILED_TAB	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Tabelle mit IDs problematischer Dokumente	20041209
5	Importing	PROTOCOL_HANDLE	Call by reference	☑	Type reference (TYPE)	SYSUUID_22		Handle des Archivierungsprotokolls	20070327

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041208

Method DELETE_DOCUMENT_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HANDLE	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Handle for archive	20041012
2	Importing	READ_NEW_ARC_OBJECT	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Lesen des nächsten Archivierungsobjektes	20041210
3	Returning	R_DOCUMENT_ID	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_ID		Document ID of found document in archive	20041013

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured during archiving	20041012

Method GET_CLIENT_SERVICE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_CLIENT_SERVICE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_SRM_CLIENT_SERVICE		Reference to client-service interface	20041015

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041214

Method GET_INSTANCE_POID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	STRING		Document-Id	20041015
2	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	STRING		RMS-ID	20041018
3	Returning	R_INSTANCE_POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		Instanz-POID	20041015
4	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	STRING		SPS-ID	20041018

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041214

Method GET_POID_DIR_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING			20041014
2	Returning	POID_DIR_TAB	Value transfer	☐	Type reference (TYPE)	STRING			20041014

Method GET_POID_DIR_TAB on class CL_SRM_KPRO_ARCHIVE has no exception.

Method GET_POID_TAB_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_ID		LOIO-ID	20041214
2	Exporting	POID_DIR_ID	Call by reference	☐	Type reference (TYPE)	STRING		POID-Directory ID des Dokumentes	20041214
3	Importing	RMS_ID	Call by reference	☑	Type reference (TYPE)	STRING		RMS_ID	20041214
4	Importing	SPS_ID	Call by reference	☑	Type reference (TYPE)	STRING		Elemenart-ID	20041214
5	Exporting	STATUS	Call by reference	☐	Type reference (TYPE)	C		Archivierungsstatus ('T'=makiert; 'A' = archiviert)	20041214

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041214

Method GET_RETENTION_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DAYS	Call by reference	☐	Type reference (TYPE)	D		number of days in the past	20041014
2	Returning	R_RETENTION_DATE	Value transfer	☐	Type reference (TYPE)	STRING		Retention date	20041014

Method GET_RETENTION_DATE on class CL_SRM_KPRO_ARCHIVE has no exception.

Method GET_RMS_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RMS_ID	Value transfer	☐	Type reference (TYPE)	STRING		RMS-ID	20041018

Method GET_RMS_ID on class CL_SRM_KPRO_ARCHIVE has no exception.

Method GET_SPS_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SPS_ID	Value transfer	☐	Type reference (TYPE)	STRING		SPS-ID	20041018

Method GET_SPS_ID on class CL_SRM_KPRO_ARCHIVE has no exception.

Method IS_DOCUMENT_ARCHIVABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_ID		LOIO-ID	20041220
2	Returning	IS_ARCHIVABLE	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Darf das Dokument archiviert werden?	20041220
3	Importing	SPS_ID	Call by reference	☑	Type reference (TYPE)	STRING		Elementart-ID	20041220

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_KPRO_ACCESS	☐	Error occured during usage of kpro functionallity	20041220

Method MARK_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING		Area	20040830
2	Importing	DAYS	Call by reference	☐	Type reference (TYPE)	D		Zurückliegende Tage	20041001
3	Changing	DOCUMENTS_TAB	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Dokumente die archiviert werden sollen	20041208
4	Changing	FAILED_TAB	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Dokumente deren Archivierung Probleme bereitet	20041208
5	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	STRING		RMS-ID	20041018
6	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	STRING		sps_id	20041018
7	Importing	STORAGE_CAT	Call by reference	☐	Type reference (TYPE)	SDOK_STCAT		Storage-category für Content (nach Archivierung)	20041209
8	Importing	TESTMODE	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Markierung im Testmodus (JA/NEIN)	20041208

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041208

Method RELOCATE_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING		Area	20041207
2	Importing	DAYS	Call by reference	☐	Type reference (TYPE)	D		Zurückliegende Tage	20041207
3	Importing	DEST_STORAGE_CATEGORY	Call by reference	☐	Type reference (TYPE)	SDOKSTCA-STOR_CAT		Ziel Speicher-Kategorie	20041207
4	Changing	FAILED_PHIOS	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Tabelle mit PHIOs bei denen Verschiebung fehlgeschlagen ist	20041208
5	Changing	RELOCATED_PHIOS	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Tabelle mit verschobenen PHIOs	20041208
6	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	STRING		RMS-ID	20041207
7	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	STRING		sps_id	20041207
8	Importing	TESTMODE	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Im Testmodus wir der Content nicht verschoben.	20041207

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041207

Method SET_RMS_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	STRING		rms-ID	20041018

Method SET_RMS_ID on class CL_SRM_KPRO_ARCHIVE has no exception.

Method SET_SPS_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	STRING		SPS-ID	20041018

Method SET_SPS_ID on class CL_SRM_KPRO_ARCHIVE has no exception.

Method WRITE_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ARCHIVE_CONTENT	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Content in das Archiv schreiben (Ja/Nein)	20041209
2	Importing	ARC_OBJ	Call by reference	☐	Type reference (TYPE)	ARCH_OBJ-OBJECT		Name of Archiving Object	20041012
3	Importing	COMMENT	Call by reference	☐	Type reference (TYPE)	ADMI_RUN-COMMENTS		Comment for archive	20041012
4	Importing	DELETE_TESTMODE	Call by reference	☐	Type reference (TYPE)	C			20041012
5	Changing	DOCUMENTS_TAB	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Tabelle mit IDs der archivierten Dokumente	20041209
6	Changing	FAILED_TAB	Call by reference	☐	Type reference (TYPE)	SRM_GSP_ARC_RESULT_TAB		Tabelle mit IDs von Dokmenten, bei dene Probleme auftraten	20041209
7	Importing	FILES_CREATE	Call by reference	☐	Type reference (TYPE)	C			20041012
8	Importing	PROTOCOL_HANDLE	Call by reference	☑	Type reference (TYPE)	SYSUUID_22		Handle des Archivierungsprotokolls	20070327

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured while performing operations on archiv	20041209

Method WRITE_DOCUMENT_INTO_ARCHIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ARCHIVE_CONTENT	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_TRUE	Content in das Archiv schreben (Ja/Nein)	20041209
2	Importing	ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SY-TABIX		Index interner Tabellen	20041006
3	Importing	CONTENT_STORAGE_CATEGORY	Call by reference	☑	Type reference (TYPE)	SDOK_STCAT		Speicherkategorie für Content	20041210
4	Importing	CREATE_NEW_ARC_OBJECT	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Neues Objekt im Archiv erzeugen (Ja/Nein)	20041209
5	Importing	DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_ID		Document ID of the document which is supposed to be archived	20041006
6	Exporting	EX_INTERRUPTED	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN		True wenn von Benutzer abgebrochen	20070327

#	Exception	Resumable	Description	Created on
1	CX_SRM_GSP_ARCHIVING	☐	Error occured during archiving	20041013

History

Last changed by/on	SAP	20110908
SAP Release Created in	700