SAP ABAP Class CL_RS_PRECALC_ADMIN (Precalculation server administration)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-ET (Application Component) End User Technology
     ⤷ RSR_EXCEL_PRECALC (Package) Package for Precalculation of Workbooks

Properties

Class	CL_RS_PRECALC_ADMIN
Short Description	Precalculation server administration
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSR_EXCEL_PRECALC	Package for Precalculation of Workbooks
Created	20091221	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_RS_PRECALC_ADMIN has no forward declaration.

Interfaces

Class CL_RS_PRECALC_ADMIN has no interface implemented.

Friends

Class CL_RS_PRECALC_ADMIN has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	APPENDED_TIMEOUTS	Instance attribute	Private	☐	Type reference (TYPE)	INT4	0	Number of Appended timeouts	20100105
2	DEFAULT_WB_T	Instance attribute	Private	☐	Type reference (TYPE)	CHAR255		Name of the Default Timeout entry	20100105
3	NUM_OF_PREC_SERVERS	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of precalculation servers	20100105
4	PREC_SERVER_LIST	Instance attribute	Private	☐	Type reference (TYPE)	RSR_PRECALC_ADMIN_SERVER_TAB		Table type precalculation server list RSPRECALCADMIN	20100105
5	PREC_SERVER_LIST_CHART_C_XML	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING		Chart: Preclaculation Server Customizing	20100105
6	PREC_SERVER_LIST_CHART_D_XML	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING		Chart: Precalculation Server	20100105
7	SELECTED_PREC_SERVER	Instance attribute	Private	☐	Type reference (TYPE)	RSR_PRECALC_ADMIN_SERVER		Selected Precalculation Server	20100105
8	TIMEOUT_LIST	Instance attribute	Private	☐	See coding				20100105

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_PREC_SERVER	Instance method	Public	Method	Add new prec server	20100105
2	CONSTRUCTOR	Instance method	Public	Constructor		20100105
3	CREATE_SERVER_LIST_C_CUST_XML	Instance method	Private	Method		20100105
4	CREATE_SERVER_LIST_C_DATA_XML	Instance method	Private	Method		20100105
5	DELETE_QUEUE_ENTRIES	Instance method	Public	Method	Delete entries from precalculation queue	20100105
6	DELETE_SELECTED_PREC_SERVER	Instance method	Public	Method	Delete a prec server	20100105
7	DELETE_SELECTED_SERVER_LOG	Instance method	Public	Method	Clear the logfile on the selected server	20100105
8	GET_DURATION_CHART_CUST_XML	Instance method	Public	Method	Returns customizing XML for duration statistics	20100105
9	GET_DURATION_CHART_DATA_XML	Instance method	Public	Method	Returns data to duration statistics	20100105
10	GET_FAILED_SETTINGS	Instance method	Public	Method	Returns the list of failed settings	20100105
11	GET_LIST_OF_TIMEOUTS	Instance method	Public	Method	Returns timeouts	20100105
12	GET_LIST_OF_WORKBOOKS	Instance method	Public	Method	List of workbooks	20100105
13	GET_NUM_OF_PREC_SERVERS	Instance method	Public	Method	Returns the Number of precalculation servers in the system	20100105
14	GET_PRECALCULATION_QUEUE	Instance method	Public	Method	Returns the precalculation queue	20100105
15	GET_PREC_SERVER_LIST	Instance method	Public	Method	Returns the list of precalculation servers	20100105
16	GET_QUEUE_CHART_CUST_XML	Instance method	Public	Method	Returns the queue statistics customizing	20100105
17	GET_QUEUE_CHART_DATA_XML	Instance method	Public	Method	Returns the queue statistics	20100105
18	GET_SELECTED_SERVER	Instance method	Public	Method	Returns the selected prec. server	20100105
19	GET_SELECTED_SERVER_LOG_HTML	Instance method	Public	Method	Returns the log of the server up to 10.000 lines /HTML/	20100105
20	GET_SERVER_LIST_CHART_CUST_XML	Instance method	Public	Method	Returns a coloring XML for the statistics XML	20100105
21	GET_SERVER_LIST_CHART_DATA_XML	Instance method	Public	Method	Returns the statistics of server statuses in XML	20100105
22	LOAD_PREC_SERVER_LIST	Instance method	Private	Method		20100105
23	REALOAD	Instance method	Public	Method	Reload the prec server content	20100105
24	RESTART_FAILED_SETTINGS	Instance method	Public	Method	Restart selected failed settings	20100105
25	SAVE_PREC_SERVER	Instance method	Private	Method	Save precalculation Server	20100105
26	SAVE_TIMEOUTS	Instance method	Public	Method	Save timeout values to database.	20100105
27	SET_SELECTED_SERVER	Instance method	Public	Method	Sets the selected server	20100105
28	SET_SERVER_DESCRIPTION	Instance method	Public	Method	Set the description of the server	20100105
29	SET_TIMEOUT_LIST	Instance method	Public	Method	Set timeout values	20100105

Events

Class CL_RS_PRECALC_ADMIN has no event.

Types

Class CL_RS_PRECALC_ADMIN has no local type.

Method Signatures

Method ADD_PREC_SERVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	RSTXTLG		Long description	20100105
2	Importing	I_GWHOST	Call by reference	☑	Type reference (TYPE)	RFCGWHOST		Gateway host name	20100806
3	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	RSRLOGSYS		Source system of the receiver	20100105

#	Exception	Resumable	Description	Created on
1	SERVER_EXIST	☐		20100105

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDICATOR	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Display load indicator	20100105

Method CONSTRUCTOR on class CL_RS_PRECALC_ADMIN has no exception.

Method CREATE_SERVER_LIST_C_CUST_XML Signature

Method CREATE_SERVER_LIST_C_CUST_XML on class CL_RS_PRECALC_ADMIN has no parameter.
Method CREATE_SERVER_LIST_C_CUST_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method CREATE_SERVER_LIST_C_DATA_XML Signature

Method CREATE_SERVER_LIST_C_DATA_XML on class CL_RS_PRECALC_ADMIN has no parameter.
Method CREATE_SERVER_LIST_C_DATA_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method DELETE_QUEUE_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENTRIES_TO_DELETE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20100105

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Deletion of queue entries failed	20100105

Method DELETE_SELECTED_PREC_SERVER Signature

Method DELETE_SELECTED_PREC_SERVER on class CL_RS_PRECALC_ADMIN has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Error during deletion	20100105
2	NOT_FOUND	☐	Server not found	20100105
3	NO_SERVER	☐	No server selected	20100105

Method DELETE_SELECTED_SERVER_LOG Signature

Method DELETE_SELECTED_SERVER_LOG on class CL_RS_PRECALC_ADMIN has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Failed to delete log file.	20100105

Method GET_DURATION_CHART_CUST_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CUST_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20100105

Method GET_DURATION_CHART_CUST_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_DURATION_CHART_DATA_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DATA_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20100105

Method GET_DURATION_CHART_DATA_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_FAILED_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATE_FROM	Call by reference	☑	Type reference (TYPE)	DATS		Field of type DATS	20100105
2	Importing	DATE_TO	Call by reference	☑	Type reference (TYPE)	DATS		Field of type DATS	20100105
3	Exporting	FAILED_SETTINGS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20100105

Method GET_FAILED_SETTINGS on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_LIST_OF_TIMEOUTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	APPENDED_ENTRIES	Call by reference	☐	Type reference (TYPE)	INT4		Number of entries appended	20100105
2	Importing	APPEND_ENTRIES	Value transfer	☑	Type reference (TYPE)	STANDARD TABLE		Append these entries to the timeout table.	20100105
3	Importing	REFRESH	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100105
4	Exporting	TIMEOUTS	Value transfer	☐	Type reference (TYPE)	STANDARD TABLE			20100105

Method GET_LIST_OF_TIMEOUTS on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_LIST_OF_WORKBOOKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TITLE	Call by reference	☑	Type reference (TYPE)	RSTXTLG		Long description	20100105
2	Exporting	WORKBOOKS	Value transfer	☐	Type reference (TYPE)	STANDARD TABLE			20100105

Method GET_LIST_OF_WORKBOOKS on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_NUM_OF_PREC_SERVERS Signature

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

Method GET_NUM_OF_PREC_SERVERS on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_PRECALCULATION_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PRECALCULATION_QUEUE	Value transfer	☐	Type reference (TYPE)	STANDARD TABLE			20100105
2	Importing	SELECTION	Call by reference	☑	Type reference (TYPE)	RSR_PRECALC_ADMIN_QUEUE		Precalculation administration queue RSPRECALCADMIN	20100105

Method GET_PRECALCULATION_QUEUE on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_PREC_SERVER_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	I_PREC_SERVER_LIST	Value transfer	☐	Type reference (TYPE)	RSR_PRECALC_ADMIN_SERVER_TAB		Table type precalculation server list RSPRECALCADMIN	20100105

Method GET_PREC_SERVER_LIST on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_QUEUE_CHART_CUST_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALL_SERVER	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100105
2	Returning	CUST_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20100105

Method GET_QUEUE_CHART_CUST_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_QUEUE_CHART_DATA_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALL_SERVER	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100105
2	Returning	DATA_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20100105

Method GET_QUEUE_CHART_DATA_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_SELECTED_SERVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PREC_SERVER	Value transfer	☐	Type reference (TYPE)	RSR_PRECALC_ADMIN_SERVER		Strusture for precalculation server data RSPRECALCADMIN	20100105

Method GET_SELECTED_SERVER on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_SELECTED_SERVER_LOG_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	HTML_LOG	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20100105
2	Importing	MAX_LINES	Call by reference	☐	Type reference (TYPE)	INT4	10000	Natural number	20100105
3	Importing	TXT	Call by reference	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=True, -=False, Space=Unknown)	20100105

#	Exception	Resumable	Description	Created on
1	FAILED	☐		20100105
2	SERVER_NOT_RUNNING	☐		20100105

Method GET_SERVER_LIST_CHART_CUST_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CUST_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20100105

Method GET_SERVER_LIST_CHART_CUST_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method GET_SERVER_LIST_CHART_DATA_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATUS_DATA_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20100105

Method GET_SERVER_LIST_CHART_DATA_XML on class CL_RS_PRECALC_ADMIN has no exception.

Method LOAD_PREC_SERVER_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDICATOR	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100105

Method LOAD_PREC_SERVER_LIST on class CL_RS_PRECALC_ADMIN has no exception.

Method REALOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INDICATOR	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100105

Method REALOAD on class CL_RS_PRECALC_ADMIN has no exception.

Method RESTART_FAILED_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RESULT_LIST	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20100105
2	Importing	SETTINGS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20100105

Method RESTART_FAILED_SETTINGS on class CL_RS_PRECALC_ADMIN has no exception.

Method SAVE_PREC_SERVER Signature

Method SAVE_PREC_SERVER on class CL_RS_PRECALC_ADMIN has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR_SAVING	☐	Error saving precalculation server	20100105

Method SAVE_TIMEOUTS Signature

Method SAVE_TIMEOUTS on class CL_RS_PRECALC_ADMIN has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR_SAVING	☐	Error saving timeouts	20100105

Method SET_SELECTED_SERVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SELECTED_SERVER	Call by reference	☐	Type reference (TYPE)	RSR_PRECALC_ADMIN_SERVER		Strusture for precalculation server data RSPRECALCADMIN	20100105

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Prec server does not exist	20100105

Method SET_SERVER_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	RSTXTLG		Long description	20100105

#	Exception	Resumable	Description	Created on
1	SERVER_NOT_SELECTED	☐	No server is selected	20100105

Method SET_TIMEOUT_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	BAD_ROW_ID	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20100105
2	Importing	TIMEOUTS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20100105

Method SET_TIMEOUT_LIST on class CL_RS_PRECALC_ADMIN has no exception.

History

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