SAP ABAP Class CL_SPI_CCMS (CCMS Monitor Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
     ⤷ SPI13 (Package) Central: Configuration + CCMS Interface

Properties

Class	CL_SPI_CCMS
Short Description	CCMS Monitor Class
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPI13	Central: Configuration + CCMS Interface
Created	20021119	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SPI_CONFIG_SRV_ATTR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SPI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SPI_CCMS has no interface implemented.

Friends

Class CL_SPI_CCMS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_AL_VAL_GREEN	Constant	Protected	☐	Type reference (TYPE)	ALALERTRC-VALUE	1	Alert: alert value (1 = green, 2 = yellow, ....)	20030325
2	GC_AL_VAL_RED	Constant	Protected	☐	Type reference (TYPE)	ALALERTRC-VALUE	3	Alert: alert value (1 = green, 2 = yellow, ....)	20021119
3	GC_AL_VAL_YELLOW	Constant	Protected	☐	Type reference (TYPE)	ALALERTRC-VALUE	2	Alert: alert value (1 = green, 2 = yellow, ....)	20030325
4	GC_AL_VISIBLE_OPERATOR	Constant	Protected	☐	Type reference (TYPE)	ALVISILEVL	1	Alert: MTE Type Dev Cust: Visible on User Level (op,exp,dev)	20021119
5	GC_ANALYSETOOL_PERF	Constant	Public	☐	Type reference (TYPE)	ALTOOLKEY	'SPI_INSTANCE'	Default Analysis Tool for Performance Attributes in the CCMS	20021121
6	GC_ANALYSETOOL_PROT	Constant	Public	☐	Type reference (TYPE)	ALTOOLKEY	'SPI_INSTANCE'	Default Analysis Tool for Log Attributes in CCMS	20030528
7	GC_ANALYSETOOL_STATUS	Constant	Public	☐	Type reference (TYPE)	ALTOOLKEY	'SPI_PROCESS'	Default Analysis Tool for Status Attributes in the CCMS	20021121
8	GC_BTCJOB_TMPL	Constant	Protected	☐	Type reference (TYPE)	BTCJOB	'SPI_DATASUP'	Standard Batch Job Template for Data Supplier Job	20030326
9	GC_CONTEXT_CLASS	Constant	Public	☐	Type reference (TYPE)	ALCUSGROUP	'PMI_CLASS'	Alert: Customization: Name of Customization Group	20021119
10	GC_CONTEXT_OWNER	Constant	Public	☐	Type reference (TYPE)	ALMCOWNER	'PMI'	Alert: Owner of Monitoring Context	20021119
11	GC_DATASUPPLIER	Constant	Public	☐	Type reference (TYPE)	SYREPID	'SPI_DATASUPPLIER_NEW'	Default CCMS Data Supplier (Generic)	20030326
12	GC_IS_ACTIVE	Constant	Public	☐	Type reference (TYPE)	CHAR10	'Active'	Monitoring Active	20030923
13	GC_IS_INACTIVE	Constant	Public	☐	Type reference (TYPE)	CHAR10	'Inactive'	Monitoring inactive	20030923
14	GC_JOB_PREFIX	Constant	Public	☐	Type reference (TYPE)	CHAR10	'DataSupp.-'	Preix for Active Data Supplier	20030903
15	GC_MONITOR_STATUS	Constant	Public	☐	Type reference (TYPE)	ALCUSGROUP	'Monitoring Status'	Attribute Name for Monitoring Status	20030925
16	GC_MTE_PREFIX	Constant	Public	☐	Type reference (TYPE)	CHAR8	'Proc.ID:'	Prefix for Monitoring Objects	20030826
17	GP_MONITOR_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ALGLOBTID		ID of the Monitor Object	20021119
18	GP_MONITOR_OBJECT	Instance attribute	Public	☑	Type reference (TYPE)	ALMTNAME		Monitor Object Name With CCMS Path	20021119
19	GP_PROCESS	Instance attribute	Public	☑	Type reference (TYPE)	SPIPROCTP		Process GUID	20021119
20	GT_ALL_MONITORS	Static Attribute	Private	☐	Type reference (TYPE)	TSPICCMS		List of Object References for CL_SPI_CCMS	20030102

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_ATTR_NAME	Static method	Public	Method	Packs PMI Attribute Name into CCMS Attribute Format	20030320
2	BUILD_CCMS_NAME	Static method	Public	Method	Forms an MT Name from a Process ID	20030224
3	BUILD_MO_NAME	Static method	Public	Method	Assembles the Name of the Monitoring Object	20030826
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20021206
5	CLEAN_UP_CCMS	Static method	Public	Method	Deletes Unreferenced Data From the CCMS	20030704
6	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20021119
7	DELETE_MONITOR	Instance method	Public	Method	Deletes the Whole Monitor from the CCMS	20021121
8	GET_CCMS_ATTRIBUTE_ID	Instance method	Public	Method	Creates a Monitor Attribute in CCMS and Returns the ID	20030325
9	GET_INSTANCE	Static method	Public	Method	Constructor with Process ID	20021119
10	GET_INSTANCE_BY_NAME	Static method	Public	Method	Returns/Generates a Monitor Instance Using ALMTNANE	20030103
11	GET_MONITOR_ID	Static method	Protected	Method	Creates Monitor Object in CCMS and Returns ID	20021119
12	GET_MONITOR_SETTINGS	Instance method	Public	Method	Returns the RZ20 Settings of an Attribute	20021119
13	GET_PMI_CONTEXT_FOR_CCMS	Static method	Public	Method	Returns Client-Specific Context Name for the CCMS	20040211
14	REPORT_ATTRIBUTE_STATE	Instance method	Public	Method	Writes Attribute Value or Attribute Status to the CCMS	20030324
15	SET_ACTIVATION_ATTRIBUTE	Instance method	Public	Method	Sets the Text Attribute 'Monitoring is' in the CCMS	20030924
16	SET_ACTIVE_ATTRIBUTES	Instance method	Public	Method	Enters a List of Service Attributes into Monitoring	20030228
17	SET_MONITOR_DESCRIPTION	Instance method	Public	Method	Sets the RZ20 Test Description for this Monitor	20030102
18	SET_MON_SETTINGS_PERF	Instance method	Public	Method	Overwrites the Settings of Performance Attributes	20030312
19	SET_MON_SETTINGS_SMSG	Instance method	Public	Method	Overwrites the Settings of Status Attributes	20030312
20	SET_TEXT_ATTRIBUTE	Instance method	Public	Method	Sets a Required Text Attribute	20030827
21	SPLIT_CCMS_NAME	Static method	Public	Method	Splits MTE Name into 4 Components & Standardizes it	20030226
22	SPLIT_MO_NAME	Static method	Public	Method	Process Type for a Monitor Object Name (if possible)	20030826

Events

Class CL_SPI_CCMS has no event.

Types

Class CL_SPI_CCMS has no local type.

Method Signatures

Method BUILD_ATTR_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_ATTRIBUTE_CCMS_NAME	Call by reference	☐	Type reference (TYPE)	ALCUSGROUP		CCMS-Attributname	20030829
2	Exporting	EP_CCMS_ATTRIBUTE_LONG	Call by reference	☐	Type reference (TYPE)	ALMTNAME		CCMS-Name: sysidPMIproctypeattribut-tool	20030829
3	Importing	IP_PMI_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	SSPIPROCATT		Prozesstyp - Attributname - Tool	20030320
4	Importing	IP_SCOPE	Call by reference	☐	Type reference (TYPE)	SPIATTRSCOPE		Gültigkeitsbereich: Prozess, Schritt oder Übergang	20030320
5	Importing	IP_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR1		Übersicht oder Instanzebene?	20030320
6	Importing	IS_DSTIME	Call by reference	☐	Type reference (TYPE)	SSPIDSTIME		Typ des Zeitintervalls	20030829

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030320
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20030320

Method BUILD_CCMS_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_CONTEXT	Call by reference	☐	Type reference (TYPE)	ALMCNAME		Character 40-Stellen	20030224
2	Importing	IP_MATTR	Call by reference	☑	Type reference (TYPE)	ALCUSGROUP		Alert: Customization: Name of Customization Group	20030226
3	Importing	IP_MOBJECT	Call by reference	☑	Type reference (TYPE)	ALCUSGROUP		SPI: ID eines Prozesstypen	20030226
4	Importing	IP_SYSID	Call by reference	☐	Type reference (TYPE)	SYSYSID		Character 40-Stellen	20030226
5	Returning	RP_VALUE	Value transfer	☐	Type reference (TYPE)	ALMTNAME		Alert: Name of MT (sysidcontextobjectnameshortname)	20030224

Method BUILD_CCMS_NAME on class CL_SPI_CCMS has no exception.

Method BUILD_MO_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCTYPE	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		Prozesstyp	20030826
2	Returning	RP_MO_NAME	Value transfer	☐	Type reference (TYPE)	ALCUSGROUP		MTE-Name	20030826

Method BUILD_MO_NAME on class CL_SPI_CCMS has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_SPI_CCMS has no parameter.
Method CLASS_CONSTRUCTOR on class CL_SPI_CCMS has no exception.

Method CLEAN_UP_CCMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_SUCCESS	Value transfer	☐	Type reference (TYPE)	SPIBOOL		TRUE:erfolgreich FALSE: fehlerhaft	20030704

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030707

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_MONITOR_OBJECT	Call by reference	☐	Type reference (TYPE)	ALMTNAME		Monitorobjektstring	20021119
2	Importing	IP_PROCTYPE	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20030226

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021119
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20021119
3	CX_SPI_MONITOR_CCMS	☐	Fehlermeldung vom CCMS	20021120

Method DELETE_MONITOR Signature

Method DELETE_MONITOR on class CL_SPI_CCMS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021206
2	CX_SPI_MONITOR	☐	Ausnahme für die Autokonfiguration von PMI-Prozessen	20030827

Method GET_CCMS_ATTRIBUTE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	SSPICONFIGSRVATTR		Seriviceattribut	20030325
2	Returning	RP_CCMS_ID	Value transfer	☐	Type reference (TYPE)	ALGLOBTID		CCMS-TID des Attributes	20030325

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030325
2	CX_SPI_MONITOR	☐	Fehlermeldung vom CCMS	20030325

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCESS	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20021119
2	Returning	RP_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SPI_CCMS		Neue Instanz	20021119

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021119
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20021119

Method GET_INSTANCE_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_MONITOR_OBJECT	Call by reference	☐	Type reference (TYPE)	ALMTNAME		Alert: Name of MT (sysidcontextobjectnameshortname)	20030103
2	Returning	RP_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SPI_CCMS		Neue Instanz	20030103

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030103
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20030103

Method GET_MONITOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCESS	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		Prozess-Id	20021119
2	Returning	RP_ID	Value transfer	☐	Type reference (TYPE)	ALGLOBTID		Monitorobjektid	20021119

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021119
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20021119
3	CX_SPI_MONITOR_CCMS	☐	Fehlermeldung vom CCMS	20021120

Method GET_MONITOR_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_SETTING	Call by reference	☐	Type reference (TYPE)	ANY		$REF$	20030311
2	Exporting	EP_STRUCTURE	Call by reference	☐	Type reference (TYPE)	STRUKNAME		$REF$	20030311
3	Importing	IP_CCMS_ATTR	Call by reference	☐	Type reference (TYPE)	ALMTNAME		$REF$	20030311

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20021119
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20021119

Method GET_PMI_CONTEXT_FOR_CCMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_CONTEXTNAME	Value transfer	☐	Type reference (TYPE)	ALMCNAME		Name des Kontextes	20040211

Method GET_PMI_CONTEXT_FOR_CCMS on class CL_SPI_CCMS has no exception.

Method REPORT_ATTRIBUTE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SPI_COMMON			20030324
2	Importing	IS_SRV_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	SSPICONFIGSRVATTR			20030324
3	Returning	RP_SUCCESS	Value transfer	☐	Type reference (TYPE)	SPIBOOL			20030324

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030325
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20030325

Method SET_ACTIVATION_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ACTIVE	Call by reference	☑	Type reference (TYPE)	SPIBOOL		Aktivierungszustand	20030924

Method SET_ACTIVATION_ATTRIBUTE on class CL_SPI_CCMS has no exception.

Method SET_ACTIVE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TSPICONFIGSRVATTR		Liste der zu aktivierenden Serviceattribute	20030228

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030228
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20030228

Method SET_MONITOR_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_TEXT_ATTR	Call by reference	☑	Type reference (TYPE)	STRING		Beschreibender Text für MTE	20030103

#	Exception	Resumable	Description	Created on
1	CX_SPI_MONITOR_CCMS	☐	Fehlermeldung vom CCMS	20030102

Method SET_MON_SETTINGS_PERF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ALMTNAME	Call by reference	☐	Type reference (TYPE)	ALMTNAME		$REF$	20030312
2	Importing	IP_CLASS_OR_SPECIFIC	Call by reference	☑	Type reference (TYPE)	ALUSECLASS		$REF$	20030313
3	Importing	IP_SETTINGS	Call by reference	☐	Type reference (TYPE)	SSPIPERFCUS		Monitorsettings für Perfomanceattribute im PMI	20030312
4	Importing	IP_VARIANT	Call by reference	☐	Type reference (TYPE)	ALCUSSETNM	'SAP-DEFAULT'	Alert: Name der Monitoringeigenschaftsvariante	20030313

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030312
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20030312

Method SET_MON_SETTINGS_SMSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ALMTNAME	Call by reference	☐	Type reference (TYPE)	ALMTNAME		$REF$	20030312
2	Importing	IP_CLASS_OR_SPECIFIC	Call by reference	☑	Type reference (TYPE)	ALUSECLASS		$REF$	20030313
3	Importing	IP_SETTINGS	Call by reference	☐	Type reference (TYPE)	SSPISMSGCUS		Customizingdaten für das Statusattribut	20030312
4	Importing	IP_VARIANT	Call by reference	☐	Type reference (TYPE)	ALCUSSETNM	'SAP-DEFAULT'	Alert: Name der Monitoringeigenschaftsvariante	20030313

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030312
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20030312

Method SET_TEXT_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	CHAR40		Attributname	20030827
2	Importing	IP_ATTR_TEXT	Call by reference	☐	Type reference (TYPE)	CHAR100		Beschreibung	20030827

Method SET_TEXT_ATTRIBUTE on class CL_SPI_CCMS has no exception.

Method SPLIT_CCMS_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CP_ALMTNAME	Call by reference	☐	Type reference (TYPE)	ALMTNAME		Alert: Name of MT (sysidcontextobjectnameshortname)	20030226
2	Exporting	EP_CONTEXT	Call by reference	☐	Type reference (TYPE)	ALMCNAME		Alert: Name eines Monitorkontextes	20030226
3	Exporting	EP_MATTR	Call by reference	☐	Type reference (TYPE)	ALCUSGROUP		Alert: Customization: Name of Customization Group	20030226
4	Exporting	EP_MOBJECT	Call by reference	☐	Type reference (TYPE)	ALCUSGROUP		Alert: Customization: Name of Customization Group	20030226
5	Exporting	EP_SYSID	Call by reference	☐	Type reference (TYPE)	SYSYSID		Alert: Name eines Monitorkontextes	20030226

#	Exception	Resumable	Description	Created on
1	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20030226
2	CX_SPI_MONITOR	☐	Ausnahme für CCMS Monitor des PMI	20030226

Method SPLIT_MO_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_MO_NAME	Call by reference	☐	Type reference (TYPE)	ALCUSGROUP		Monitorobjektname	20030826
2	Returning	RP_PROCTYPE	Value transfer	☐	Type reference (TYPE)	SPIPROCTP		Prozesstyp	20030826

#	Exception	Resumable	Description	Created on
1	CX_SPI_MONITOR	☐	Ausnahme für die Autokonfiguration von PMI-Prozessen	20030826

History

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