SAP ABAP Class CL_RSOD_ADMIN (BW Documents: Administration)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-WHM-MTD (Application Component) Metadata (Repository)
     ⤷ RSOD_EXTENSION (Package) BW Document Connection (Components Outside of CORE)

Properties

Class	CL_RSOD_ADMIN
Short Description	BW Documents: Administration
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSOD_EXTENSION	BW Document Connection (Components Outside of CORE)
Created	20010608	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	RSOS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSOD_ADMIN has no interface implemented.

Friends

Class CL_RSOD_ADMIN has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_JOBNAME	Constant	Public	☐	Type reference (TYPE)	BTCJOB	'BW_DOCUMENTS_INDEXING'		20010608
2	C_JOB_DIALOG_NO	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1	'N'		20010608
3	C_JOB_DIALOG_YES	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1	'Y'		20010608
4	C_MIGRATION_PCD_PATH	Constant	Private	☐	Type reference (TYPE)	STRING	'portal_content/com.sap.pct/platform_add_ons/com.sap.ip.bi/iViews/com.sap.ip.bi.documentmigration'		20050830
5	C_PARAM_GDOC_EXCLUDE_RECE_DATA	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'GDOC_EXCLUDE_RECEIVE_DATA'		20030508
6	C_PARAM_GDOC_EXCLUDE_SEND_DATA	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'GDOC_EXCLUDE_SEND_DATA'		20030508
7	C_PARAM_GDOC_EXCLUDE_USAGE	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'GDOC_EXCLUDE_USAGE'		20030508
8	C_PARAM_GENERATE	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'GENERATE'		20030508
9	C_PARAM_MAX_PROP	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'MAX_PROP'		20030508
10	C_PARAM_MAX_PROP_FOR_SELECT	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'MAX_PROP_SELECT'		20030508
11	C_PARAM_PROXY	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'HTTP_PROXY'		20030508
12	C_PARAM_PROXY_PWD	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'HTTP_PROXY_PWD'		20030508
13	C_PARAM_PROXY_USER	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'HTTP_PROXY_USER'		20030508
14	C_PARAM_TEMPLATE	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'TEMPLATE'		20030508
15	C_PARAM_VERSION_HANDLING	Constant	Public	☐	Type reference (TYPE)	SDOK_PROPN	'VERSION_HANDLING'		20030123
16	C_PORTAL_NAVIGATION_URL	Constant	Private	☐	Type reference (TYPE)	STRING	'/irj/portal?NavigationTarget=ROLES://'		20050830
17	C_TABSTRIP_CONTENT	Constant	Public	☐	Type reference (TYPE)	I	1		20010608
18	C_TABSTRIP_GEN_PROP	Constant	Public	☐	Type reference (TYPE)	I	3		20010608
19	C_TABSTRIP_INDEX	Constant	Public	☐	Type reference (TYPE)	I	2		20010608
20	C_TABSTRIP_METAINDEX	Constant	Public	☐	Type reference (TYPE)	I	5		20050117
21	N_METAINDXSTATE	Instance attribute	Public	☐	Type reference (TYPE)	RSOS_STATUSFL			20040617
22	N_STATE	Instance attribute	Public	☐	Type reference (TYPE)	RSODINDXSTATE			20010608
23	N_TABSTRIP	Instance attribute	Public	☑	Type reference (TYPE)	I			20010608
24	P_GDOC_EXCLUDE_RECE_DATA	Static Attribute	Private	☐	Type reference (TYPE)	RS_BOOL			20030513
25	P_GDOC_EXCLUDE_SEND_DATA	Static Attribute	Private	☐	Type reference (TYPE)	RS_BOOL			20030513
26	P_GDOC_EXCLUDE_USAGE	Static Attribute	Private	☐	Type reference (TYPE)	RS_BOOL			20030513
27	P_GDOC_SETTINGS_ACTIVE	Static Attribute	Private	☐	Type reference (TYPE)	RS_BOOL			20030513
28	P_TEXT_SHOWN	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL			20010608
29	P_T_GEN_PROP	Instance attribute	Private	☐	Type reference (TYPE)	RSOD_T_SCGENPROP			20010611

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACT_SETTINGS_DOC_GENERATION	Static method	Public	Method		20030513
2	CONFG_OBJECT_TYPES	Instance method	Public	Method	Ruft Pflege-View zum Konfigurieren von Objekttypen auf	20040618
3	CONSTRUCTOR	Instance method	Public	Constructor		20010608
4	DELETE_WEB_TMP	Instance method	Public	Method		20021210
5	GENERATE_PROPERTIES	Instance method	Public	Method		20010611
6	GET_CREP_INFO	Static method	Public	Method		20010611
7	GET_GENERATED_PROPERTIES	Instance method	Public	Method		20010611
8	GET_INDEXING_STATE	Instance method	Public	Method	old document search: Get documents indexing Status	20010730
9	GET_INDEXJOB_STATE	Instance method	Public	Method		20010608
10	GET_INDEX_STATUS	Instance method	Public	Method		20060201
11	GET_METADATA_DINDEXJOB_STATE	Instance method	Public	Method	Status von Metadaten-Delta-Indizierungsjob holen	20040617
12	GET_METADATA_INDX_STATE	Instance method	Public	Method	Obsolete (-> GET_INDEX_STATUS)	20040617
13	GET_PROP_GENERATION	Static method	Public	Method		20010611
14	GET_RSODADMIN	Static method	Public	Method		20020102
15	GET_SENGINE_STATE	Static method	Public	Method		20010730
16	GET_SETTINGS_DOC_GENERATION	Static method	Public	Method		20030508
17	GET_SSRID_DEFAULT	Static method	Public	Method		20010730
18	GET_TREXENGINE_STAT	Static method	Public	Method	Zum Holen von Status von TREX-Installation	20040809
19	GET_WEB_TMP_CNT	Instance method	Public	Method		20021210
20	GUI	Instance method	Public	Method		20010608
21	GUI_DOC	Instance method	Public	Method	Start GUI for Documents	20051216
22	JOB_OVERVIEW	Instance method	Public	Method		20010608
23	MAINTAIN_CREP	Instance method	Public	Method		20010608
24	METADATA_APP_LOG	Instance method	Public	Method	Zeigt Anwendungsprotokoll an	20040630
25	METADATA_DINDX_JOB_OVERVIEW	Instance method	Public	Method	Jobübersicht von Metadaten-Delta-Indizierungsjob	20040617
26	MONITOR	Instance method	Public	Method		20010608
27	REINDEX	Instance method	Public	Method		20010608
28	RESET_SETTINGS_DOC_GENERATION	Static method	Public	Method		20030513
29	SCHEDULE	Instance method	Public	Method		20010608
30	SET_INDEXING_STATE	Instance method	Public	Method	old document search: Set documents indexing Status	20010730
31	SET_INDEX_STATUS	Instance method	Public	Method		20060201
32	SET_METADATA_INDX_STATE	Instance method	Public	Method	Obsolete (-> SET_INDEX_STATUS)	20040617
33	SET_PROP_GENERATION	Static method	Public	Method		20010611
34	SET_RSODADMIN	Static method	Public	Method		20020102
35	START_PORTAL_MIGRATION	Instance method	Public	Method	Start of portal migration in the Portal	20050829

Events

Class CL_RSOD_ADMIN has no event.

Types

Class CL_RSOD_ADMIN has no local type.

Method Signatures

Method ACT_SETTINGS_DOC_GENERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXCLUDE_RECEIVE_DATA	Call by reference	☐	Type reference (TYPE)	RS_BOOL		= 'X': Links "empfängt Daten" des Objektes nicht generieren	20030513
2	Importing	I_EXCLUDE_SEND_DATA	Call by reference	☐	Type reference (TYPE)	RS_BOOL		= 'X': Links "sendet Daten an" des Objektes nicht generieren	20030513
3	Importing	I_EXCLUDE_USAGE	Call by reference	☐	Type reference (TYPE)	RS_BOOL		= 'X': Links "Verwendung" des Objektes nicht generieren	20030513

Method ACT_SETTINGS_DOC_GENERATION on class CL_RSOD_ADMIN has no exception.

Method CONFG_OBJECT_TYPES Signature

Method CONFG_OBJECT_TYPES on class CL_RSOD_ADMIN has no parameter.
Method CONFG_OBJECT_TYPES on class CL_RSOD_ADMIN has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_RSOD_ADMIN has no parameter.
Method CONSTRUCTOR on class CL_RSOD_ADMIN has no exception.

Method DELETE_WEB_TMP Signature

Method DELETE_WEB_TMP on class CL_RSOD_ADMIN has no parameter.
Method DELETE_WEB_TMP on class CL_RSOD_ADMIN has no exception.

Method GENERATE_PROPERTIES Signature

Method GENERATE_PROPERTIES on class CL_RSOD_ADMIN has no parameter.
Method GENERATE_PROPERTIES on class CL_RSOD_ADMIN has no exception.

Method GET_CREP_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CREP	Call by reference	☐	Type reference (TYPE)	SCMS_CREP		Ablageort für physische Dokumente	20010611
2	Exporting	E_CREP_TYPE	Call by reference	☐	Type reference (TYPE)	SCMS_CRTYP		Ablagetyp (R/3-Datenbank, HTTP Content Server,...)	20010611
3	Exporting	E_CRTY_TEXT	Call by reference	☐	Type reference (TYPE)	TEXT30		Text 30 Stellen	20010716
4	Exporting	E_LOIO_CNT	Call by reference	☐	Type reference (TYPE)	I		Anzahl LOIO Dokumente	20010611
5	Exporting	E_PHIO_CNT	Call by reference	☐	Type reference (TYPE)	I		Anzahl PHIO Dokumente	20010611
6	Importing	I_DOC_CLASS	Call by reference	☐	Type reference (TYPE)	RSOD_DOC_CLASS		BW Dokumentenklasse	20010611

#	Exception	Resumable	Description	Created on
1	CX_RS_NOT_FOUND	☐	Objekt nicht gefunden	20010611

Method GET_GENERATED_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_GEN_PROP	Value transfer	☐	Type reference (TYPE)	RSOD_T_SCGENPROP		Aministration Dokumente: Generierte Eigenschaften im TC	20010611

Method GET_GENERATED_PROPERTIES on class CL_RSOD_ADMIN has no exception.

Method GET_INDEXING_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STATE	Value transfer	☐	Type reference (TYPE)	RSODINDXSTATE		Status der Indizierung	20010730

Method GET_INDEXING_STATE on class CL_RSOD_ADMIN has no exception.

Method GET_INDEXJOB_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DATE	Call by reference	☐	Type reference (TYPE)	SY-DATUM		Datum und Zeit, aktuelles (Applikationsserver-)Datum	20010608
2	Exporting	E_INDXJOBSTATE	Call by reference	☐	Type reference (TYPE)	RSODINDXJOBSTATE		Status des Indizierungsjobs	20010608
3	Exporting	E_TIME	Call by reference	☐	Type reference (TYPE)	SY-UZEIT		Datum und Zeit, aktuelle (Applikationsserver-) Uhrzeit	20010608

Method GET_INDEXJOB_STATE on class CL_RSOD_ADMIN has no exception.

Method GET_INDEX_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STATE	Value transfer	☐	Type reference (TYPE)	RSOS_INDEX_STATUS		Index Status	20060201

Method GET_INDEX_STATUS on class CL_RSOD_ADMIN has no exception.

Method GET_METADATA_DINDEXJOB_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DATE	Call by reference	☐	Type reference (TYPE)	SY-DATUM		Datum und Zeit, aktuelles (Application Server) Datum	20040617
2	Exporting	E_INDXJOBSTATE	Call by reference	☐	Type reference (TYPE)	RSODINDXJOBSTATE		Status des Indizierungsjobs	20040617
3	Exporting	E_PRDDAYS	Call by reference	☐	Type reference (TYPE)	BTCPDAY		Duration period (in hours) for a batch job	20060123
4	Exporting	E_PRDHOURS	Call by reference	☐	Type reference (TYPE)	BTCPHOUR		Duration period (in hours) for a batch job	20060123
5	Exporting	E_PRDMINS	Call by reference	☐	Type reference (TYPE)	BTCPMIN		Duration period (in minutes) for a batch job	20060123
6	Exporting	E_PRDMONTHS	Call by reference	☐	Type reference (TYPE)	BTCPMNTH		Duration period (in months) for a batch job	20060123
7	Exporting	E_PRDWEEKS	Call by reference	☐	Type reference (TYPE)	BTCPWEEK		Duration period (in weeks) for a batch job	20060123
8	Exporting	E_TIME	Call by reference	☐	Type reference (TYPE)	SY-UZEIT		Datum und Zeit, aktuelle (Applikationsserver-) Uhrzeit	20040617

Method GET_METADATA_DINDEXJOB_STATE on class CL_RSOD_ADMIN has no exception.

Method GET_METADATA_INDX_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STATE	Value transfer	☐	Type reference (TYPE)	RSOS_STATUSFL		Gibt Status für die Indizierung/Suche an	20040617

Method GET_METADATA_INDX_STATE on class CL_RSOD_ADMIN has no exception.

Method GET_PROP_GENERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GENERATE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	= 'X': Attribute nachgenerieren, falls nötig	20010611
2	Returning	R_GENERATION	Value transfer	☐	Type reference (TYPE)	RS_BOOL		= 'X': Nachgenerierung nötig	20010611

Method GET_PROP_GENERATION on class CL_RSOD_ADMIN has no exception.

Method GET_RSODADMIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	SDOK_PROPN		Name der Eigenschaft	20020102
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	SDOK_PROPV		Attributausprägung	20020102

Method GET_RSODADMIN on class CL_RSOD_ADMIN has no exception.

Method GET_SENGINE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STATE	Value transfer	☐	Type reference (TYPE)	RSODSENGINESTATE		Status der Suchmaschine	20010730

Method GET_SENGINE_STATE on class CL_RSOD_ADMIN has no exception.

Method GET_SETTINGS_DOC_GENERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXCLUDE_RECEIVE_DATA	Call by reference	☐	Type reference (TYPE)	RS_BOOL		= 'X': Links "empfängt Daten" des Objektes nicht generieren	20030508
2	Exporting	E_EXCLUDE_SEND_DATA	Call by reference	☐	Type reference (TYPE)	RS_BOOL		= 'X': Links "sendet Daten an" des Objektes nicht generieren	20030508
3	Exporting	E_EXCLUDE_USAGE	Call by reference	☐	Type reference (TYPE)	RS_BOOL		= 'X': Links "Verwendung" des Objektes nicht generieren	20030508

Method GET_SETTINGS_DOC_GENERATION on class CL_RSOD_ADMIN has no exception.

Method GET_SSRID_DEFAULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SSRID	Value transfer	☐	Type reference (TYPE)	SRET_SSRID		Search Server Relation ID	20010730

Method GET_SSRID_DEFAULT on class CL_RSOD_ADMIN has no exception.

Method GET_TREXENGINE_STAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_STATE	Value transfer	☐	Type reference (TYPE)	RSOSTENGINESTATE		Status von TREX-Suchmaschine	20040809

Method GET_TREXENGINE_STAT on class CL_RSOD_ADMIN has no exception.

Method GET_WEB_TMP_CNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_CNT	Value transfer	☐	Type reference (TYPE)	I			20021210

Method GET_WEB_TMP_CNT on class CL_RSOD_ADMIN has no exception.

Method GUI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TABSTRIP	Call by reference	☐	Type reference (TYPE)	I	C_TABSTRIP_METAINDEX	Register (Konstanten der Klasse verwenden)	20010608

Method GUI on class CL_RSOD_ADMIN has no exception.

Method GUI_DOC Signature

Method GUI_DOC on class CL_RSOD_ADMIN has no parameter.
Method GUI_DOC on class CL_RSOD_ADMIN has no exception.

Method JOB_OVERVIEW Signature

Method JOB_OVERVIEW on class CL_RSOD_ADMIN has no parameter.
Method JOB_OVERVIEW on class CL_RSOD_ADMIN has no exception.

Method MAINTAIN_CREP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CREP	Call by reference	☐	Type reference (TYPE)	SCMS_CREP		Ablageort für physische Dokumente	20010608

Method MAINTAIN_CREP on class CL_RSOD_ADMIN has no exception.

Method METADATA_APP_LOG Signature

Method METADATA_APP_LOG on class CL_RSOD_ADMIN has no parameter.
Method METADATA_APP_LOG on class CL_RSOD_ADMIN has no exception.

Method METADATA_DINDX_JOB_OVERVIEW Signature

Method METADATA_DINDX_JOB_OVERVIEW on class CL_RSOD_ADMIN has no parameter.
Method METADATA_DINDX_JOB_OVERVIEW on class CL_RSOD_ADMIN has no exception.

Method MONITOR Signature

Method MONITOR on class CL_RSOD_ADMIN has no parameter.
Method MONITOR on class CL_RSOD_ADMIN has no exception.

Method REINDEX Signature

Method REINDEX on class CL_RSOD_ADMIN has no parameter.
Method REINDEX on class CL_RSOD_ADMIN has no exception.

Method RESET_SETTINGS_DOC_GENERATION Signature

Method RESET_SETTINGS_DOC_GENERATION on class CL_RSOD_ADMIN has no parameter.
Method RESET_SETTINGS_DOC_GENERATION on class CL_RSOD_ADMIN has no exception.

Method SCHEDULE Signature

Method SCHEDULE on class CL_RSOD_ADMIN has no parameter.
Method SCHEDULE on class CL_RSOD_ADMIN has no exception.

Method SET_INDEXING_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STATE	Value transfer	☐	Type reference (TYPE)	RSODINDXSTATE		Status der Indizierung	20010730

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20010730

Method SET_INDEX_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX_STATUS	Call by reference	☐	Type reference (TYPE)	RSOS_INDEX_STATUS		Index Status	20060201

Method SET_INDEX_STATUS on class CL_RSOD_ADMIN has no exception.

Method SET_METADATA_INDX_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STATE	Value transfer	☐	Type reference (TYPE)	RSOS_STATUSFL		Status für Indizierung/Suche	20040617

Method SET_METADATA_INDX_STATE on class CL_RSOD_ADMIN has no exception.

Method SET_PROP_GENERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GENERATION	Call by reference	☐	Type reference (TYPE)	RS_BOOL		= 'X': Nachgenerierung nötig	20010611

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20010611

Method SET_RSODADMIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	SDOK_PROPN		Name der Eigenschaft	20020102
2	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	C			20020102

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20020102

Method START_PORTAL_MIGRATION Signature

Method START_PORTAL_MIGRATION on class CL_RSOD_ADMIN has no parameter.
Method START_PORTAL_MIGRATION on class CL_RSOD_ADMIN has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	30A