SAP ABAP Class CL_SRT_HEALTH_CHECK_CNTR (Controller for the health check)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-WS-ABA-CFG (Application Component) WebServices ABAP Configuration
     ⤷ SOAP_CONFIG_CHECK (Package) Check tools for SOAP Configuration Framework

Properties

Class	CL_SRT_HEALTH_CHECK_CNTR
Short Description	Controller for the health check
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAP_CONFIG_CHECK	Check tools for SOAP Configuration Framework
Created	20100217	SAP
Last change	20130531	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)

Interfaces

Class CL_SRT_HEALTH_CHECK_CNTR has no interface implemented.

Friends

Class CL_SRT_HEALTH_CHECK_CNTR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	COMPONENT_LIST	Instance attribute	Protected	☐	Type reference (TYPE)	SRT_HCHECK_COMP_TBL		Table of health check items	20110117
2	CO_CLASS_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'CL_SRT_HEALTH_CHECK_CNTR'		20110117
3	CO_NAMESPACE	Constant	Private	☐	Type reference (TYPE)	STRING	'http://ping.check.srt.sap.com'		20110117
4	CO_TIME_RANGE_NAME	Constant	Private	☐	Type reference (TYPE)	STRING	'Health check time range'		20110117
5	C_GROUP_ADMIN_SERVICE	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_AS'		20121029
6	C_GROUP_CONNECT	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_CONNECT'		20110117
7	C_GROUP_CONSISTENCY	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_CONSIST'		20110117
8	C_GROUP_IBC	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_IBC'		20110117
9	C_GROUP_ICF	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_ICF'		20110117
10	C_GROUP_LRD	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_LRD'		20110117
11	C_GROUP_PING	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_PING'		20110117
12	C_GROUP_SMD	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_SMD'	Group ID for Services Indentification	20110117
13	C_GROUP_TECH_SET	Constant	Public	☐	Type reference (TYPE)	STRING	'GRP_TS'		20110117
14	C_PROGRESS_STATUS_CANCELLED	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS	'CANCELLED'	Check is Cancelled	20110117
15	C_PROGRESS_STATUS_COMPLETED	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS	'COMPLETED'	Check is successfully processed by Component	20110117
16	C_PROGRESS_STATUS_ERROR	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS	'ERROR'	Check is processed with Error	20110117
17	C_PROGRESS_STATUS_INACTIVE	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS	'INACTIVE'	SRT Health Check: Component Check Status	20110117
18	C_PROGRESS_STATUS_IN_PROCESS	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS	'IN_PROCESS'	Check in process by Component	20110117
19	C_PROGRESS_STATUS_NOT_STARTED	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS	'NOTSTARTED'	SRT Health Check: Component Check Status	20110117
20	C_PROGRESS_STATUS_OPEN	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS	'OPEN'	Check not yet started by Component	20110117
21	C_REPAIR_ALL_OBJECT_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'ALL'		20110117
22	C_STATUS_FAILED	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_RESULT_STATUS	'FAILED'	SRT Health Check: Component Check Status	20110117
23	C_STATUS_SUCCESS	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_RESULT_STATUS	'SUCCESS'	SRT Health Check: Component Check Status	20110117
24	C_STATUS_WARNING	Constant	Public	☐	Type reference (TYPE)	SRT_WSP_HCHECK_RESULT_STATUS	'WARNING'	SRT Health Check: Component Check Status	20110117
25	GROUP_LIST	Instance attribute	Protected	☐	Type reference (TYPE)	SRT_HCHECK_GROUP_TBL		Table of group infos	20110117
26	M_SYSTEM_KEY	Instance attribute	Private	☐	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		SOAManager Connectivity: System Key	20110117
27	S_TASK_NAME_INDEX	Static Attribute	Private	☐	Type reference (TYPE)	CHAR3		3-Byte field	20110117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_NAVIGATION_URL	Static method	Public	Method	Build Navigation WD url	20110117
2	CALL_CONNECTIVITY	Instance method	Private	Method	Calls the connectivity	20110117
3	CLEAR	Static method	Public	Method	Clears automatically all entries	20110117
4	CONSTRUCTOR	Instance method	Public	Constructor	Contructor	20110117
5	DELETE	Instance method	Public	Method	Delete health check	20110117
6	DOWNLOAD	Instance method	Public	Method	Download Excel File to Presentation Server	20110117
7	EXPORT	Instance method	Public	Method	Transform Health Check Result to Excel	20110117
8	GET_DB_LAYER	Static method	Private	Method	Get DB Layer instance	20110117
9	GET_DELETION_TIME_RANGE	Static method	Public	Method	Gets the deletion time range	20110117
10	GET_HEALTH_CHECK_COMPONENTS	Instance method	Public	Method	Gets a list of all health checks	20110117
11	GET_HEALTH_CHECK_GROUPS	Instance method	Public	Method	Gets the list of groups	20110117
12	GET_HEALTH_CHECK_RESULTS	Instance method	Public	Method	Collect the results of all health check components	20110117
13	GET_HISTORY	Instance method	Public	Method	gets a list of existing checks	20110117
14	GET_JOINT_COMPONENT_LIST	Instance method	Private	Method	Gets a list of supported components by remote and local sys.	20110117
15	GET_NAV_URL_FOR_CHECK_ID	Instance method	Public	Method	Returns Navigation URL for Check ID	20110117
16	GET_STATUS	Instance method	Public	Method	Get status of health check	20110117
17	KEEP_CHECK	Instance method	Public	Method	Keeps the check i.e. do not automatically remove it.	20110117
18	REGISTER_COMPONENTS	Instance method	Private	Method	Register your component here	20110117
19	RERUN_CHECK	Instance method	Public	Method	Reruns checks again	20110117
20	RUN_CHECK	Instance method	Public	Method	Creates a new health check	20110117
21	SET_COMPONENT_ACTIVE	Instance method	Public	Method	Activates or deactivate a health check component	20110117
22	SET_DELETION_TIME_RANGE	Static method	Public	Method	Sets the deletion time range	20110117
23	UPDATE_HEALTH_CHECK_STATUS	Instance method	Public	Method	Update the final result	20110117

Events

Class CL_SRT_HEALTH_CHECK_CNTR has no event.

Types

Class CL_SRT_HEALTH_CHECK_CNTR has no local type.

Method Signatures

Method BUILD_NAVIGATION_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLICATION_PATH	Call by reference	☑	Type reference (TYPE)	STRING			20110117
2	Importing	I_SOAMANAGER_COMPONENT	Call by reference	☑	Type reference (TYPE)	STRING			20110117
3	Importing	I_SYSTEM_KEY	Call by reference	☑	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		SOAManager Connectivity: System Key	20110117
4	Returning	R_NAVIGATION_URL	Value transfer	☐	Type reference (TYPE)	STRING			20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method CALL_CONNECTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_RESPONSE	Value transfer	☐	Type reference (TYPE)	ANY			20110117
2	Importing	I_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_CON_APPL_OPERATION		SOAManager Connectivity : Application operation	20110117
3	Importing	I_REQUEST_DATA	Call by reference	☑	Type reference (TYPE)	ANY			20110117
4	Importing	I_RESPONSE_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR30		30 Characters	20110117
5	Importing	I_SYSTEM_KEY	Call by reference	☑	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		SOAManager Connectivity: System Key	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method CLEAR Signature

Method CLEAR on class CL_SRT_HEALTH_CHECK_CNTR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMPONENT_NAME	Call by reference	☑	Type reference (TYPE)	SRT_WSP_HCHECK_COMPONENT_NAME		Active Component	20110117
2	Importing	I_COMPONENT_NAME_TAB	Call by reference	☑	Type reference (TYPE)	SRT_HCHECK_COMP_NAME_TAB		List of Active Components	20110117
3	Importing	I_GROUP_ID	Call by reference	☑	Type reference (TYPE)	STRING		Active Group	20110117
4	Importing	I_GROUP_ID_TAB	Call by reference	☑	Type reference (TYPE)	STRING_TABLE		List of Active Groups	20110117
5	Importing	I_TENANT_KEY	Call by reference	☑	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		Must only be supplied if calling a remote system	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117
2	Importing	I_SYSTEM_KEY	Call by reference	☐	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		SOAManager Connectivity: System Key	20110117
3	Returning	XSTR	Value transfer	☐	Type reference (TYPE)	XSTRING			20110117

Method DOWNLOAD on class CL_SRT_HEALTH_CHECK_CNTR has no exception.

Method EXPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117
2	Importing	I_SYSTEM_KEY	Call by reference	☐	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		SOAManager Connectivity: System Key	20110117
3	Returning	XSTR	Value transfer	☐	Type reference (TYPE)	XSTRING			20110117

Method EXPORT on class CL_SRT_HEALTH_CHECK_CNTR has no exception.

Method GET_DB_LAYER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRT_WSP_HCHK_DB_CONTROLLER		SRT Health Check: DB Operations for Controller Class	20110117

Method GET_DB_LAYER on class CL_SRT_HEALTH_CHECK_CNTR has no exception.

Method GET_DELETION_TIME_RANGE Signature

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

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method GET_HEALTH_CHECK_COMPONENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_COMPONENTS	Call by reference	☐	Type reference (TYPE)	SRT_HCHECK_COMP_TBL		Table of health check items	20110117
2	Importing	I_INSTANTIATE_COMPONENTS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_FALSE	Boolean Variable (X=True, -=False, Space=Unknown)	20110117
3	Importing	I_JOIN_LISTS	Call by reference	☐	Type reference (TYPE)	BOOLEAN	ABAP_TRUE	In remote case:Return supported components only!	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method GET_HEALTH_CHECK_GROUPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CHECK_GROUPS	Call by reference	☐	Type reference (TYPE)	SRT_HCHECK_GROUP_TBL		Group info for grouping health check item	20110117

Method GET_HEALTH_CHECK_GROUPS on class CL_SRT_HEALTH_CHECK_CNTR has no exception.

Method GET_HEALTH_CHECK_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT_DATA	Call by reference	☐	Type reference (TYPE)	STTY_SRT_HCHECK_RESULT_DATA		Health check result	20110117
2	Exporting	E_RESULT	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_RESULT_STATUS		SRT Health Check: Component Check Status	20110117
3	Exporting	E_STATUS	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS		SRT Health Check: Component Check Status	20110117
4	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method GET_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CHECK_HEADERS	Call by reference	☐	Type reference (TYPE)	SRT_UI_HCHECK_HEADER_TBL		Table of check headers	20110117
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Messages	20110117
3	Importing	I_LOCAL	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method GET_JOINT_COMPONENT_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_COMPONENT_LIST	Value transfer	☐	Type reference (TYPE)	SRT_HCHECK_COMP_TBL		Table of health check items	20110117
2	Returning	RT_SUPPORTED_COMPONENTS	Value transfer	☐	Type reference (TYPE)	SRT_HCHECK_COMP_TBL		Table of health check items	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method GET_NAV_URL_FOR_CHECK_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117
2	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20110117

Method GET_NAV_URL_FOR_CHECK_ID on class CL_SRT_HEALTH_CHECK_CNTR has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_PROGRESS_STATUS	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_STATUS		SRT Health Check: Component Check Status	20110117
2	Exporting	E_RESULT_STATUS	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_RESULT_STATUS		SRT Health Check: Component Check Status	20110117
3	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117
4	Importing	I_SYSTEM_KEY	Call by reference	☑	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		SOAManager Connectivity: System Key	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method KEEP_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method REGISTER_COMPONENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COMPONENT_LIST	Call by reference	☐	Type reference (TYPE)	SRT_HCHECK_COMP_TBL		Table of health check items	20110117

Method REGISTER_COMPONENTS on class CL_SRT_HEALTH_CHECK_CNTR has no exception.

Method RERUN_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117
2	Importing	I_SYSTEM_KEY	Call by reference	☑	Type reference (TYPE)	SRT_WSP_CON_TENANT_KEY		SOAManager Connectivity: System Key	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method RUN_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117
2	Importing	I_ASYNC_PROCESSING	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110117
3	Importing	I_CHECK_ID	Call by reference	☑	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		If supplied, this check id is used	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method SET_COMPONENT_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVE	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110117
2	Importing	I_COMPONENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20110117
3	Importing	I_EXC_IN_CLIENT	Call by reference	☑	Type reference (TYPE)	SRT_WSP_HCHECK_CLIENT		Client for Health check	20110117

Method SET_COMPONENT_ACTIVE on class CL_SRT_HEALTH_CHECK_CNTR has no exception.

Method SET_DELETION_TIME_RANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TIME_RANGE	Call by reference	☐	Type reference (TYPE)	I			20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

Method UPDATE_HEALTH_CHECK_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_ID	Call by reference	☐	Type reference (TYPE)	SRT_WSP_HCHECK_CHECK_ID		SRT Health Check : Check ID	20110117

#	Exception	Resumable	Description	Created on
1	CX_SRT_WSP_CONFIG	☐	WSP Exception	20110117

History

Last changed by/on	SAP	20130531
SAP Release Created in	740