SAP ABAP Class CL_XI_ALERT (XI Alert)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-WKB (Application Component) Runtime Workbench/Monitoring
     ⤷ SXMSALERT (Package) XI Alert Framework

Properties

Class	CL_XI_ALERT
Short Description	XI Alert
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SXMSALERT	XI Alert Framework
Created	20050720	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_XI_ALERT has no forward declaration.

Interfaces

Class CL_XI_ALERT has no interface implemented.

Friends

Class CL_XI_ALERT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ADAPTERTYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20060203
2	CLIENT	Instance attribute	Private	☐	Type reference (TYPE)	MANDT		Client	20060406
3	ERRORAREA_IE	Instance attribute	Private	☐	Type reference (TYPE)	SXMSERRAREA		XI: System Error Area	20060203
4	ERRORID_IE	Instance attribute	Private	☐	Type reference (TYPE)	SXMSERRID		XI: Error ID	20060203
5	ERRORPARAM_AF	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTAFERRPARAM_T		Error Parameters for AF	20060203
6	ERRORTEXT_AF	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20060203
7	ERROR_CODE_IE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20060203
8	EXTMSGGUID	Instance attribute	Private	☐	Type reference (TYPE)	SXMSMGUIDC		Message ID Transferred by Application	20091014
9	FALSE	Constant	Public	☐	Type reference (TYPE)	BOOLEAN_01	'0'	Boolean Variable ('1'=true,'0'=false)	20130320
10	HOST	Instance attribute	Private	☐	Type reference (TYPE)	SY-HOST		Host Name	20060406
11	MATCHING_RULES	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTRULES_T		Suitable Alert Rules	20060203
12	MDTURL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20060203
13	MDTURL_SECURE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20060203
14	MSGGUID	Instance attribute	Private	☐	Type reference (TYPE)	SXMSMGUIDC		Message ID: For Log GUID Only	20060203
15	RECEIVER	Instance attribute	Private	☐	Type reference (TYPE)	SXI_FROMORTO		XI: Address (Party/Service) & Interface	20060203
16	ROLE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR2		Role	20070207
17	SENDER	Instance attribute	Private	☐	Type reference (TYPE)	SXI_FROMORTO		XI: Address (Party/Service) & Interface	20060203
18	SYSID	Instance attribute	Private	☐	Type reference (TYPE)	SY-SYSID		System ID	20060406
19	SYSNAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		System name	20060406
20	TRUE	Constant	Public	☐	Type reference (TYPE)	BOOLEAN_01	'1'	Boolean Variable ('1'=true,'0'=false)	20130320
21	USERDEFATTR	Instance attribute	Private	☐	Type reference (TYPE)	SXMSALERTUSERDEFATTR_T		Name/Value for User-Defined Message Attributes	20100105

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060203
2	CREATE_ALERT	Instance method	Public	Method	Creates Alerts	20060203
3	FILL_ALERT_CONTAINER	Instance method	Private	Method	Fills Container Variables	20060203
4	GET_MD5_FROM_ERRORTXT	Instance method	Private	Method	Calculates MD5 Hash from Error Texts	20060203
5	HAS_ACTIVE_RULE	Instance method	Public	Method	Searches Active Alert Rules	20060203
6	SUPPRESS_TIMEOUT_CHECK	Instance method	Public	Method	Searches Active Alert Rules	20130320

Events

Class CL_XI_ALERT has no event.

Types

Class CL_XI_ALERT has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADAPTERTYPE	Call by reference	☑	Type reference (TYPE)	STRING			20060203
2	Importing	CLIENT	Call by reference	☐	Type reference (TYPE)	MANDT		Komponente der Versionsnummer	20060203
3	Importing	ERRORAREA_IE	Call by reference	☑	Type reference (TYPE)	SXMSERRAREA		XI: Systemfehler-Gebiet	20060203
4	Importing	ERRORID_IE	Call by reference	☑	Type reference (TYPE)	SXMSERRID		XI: Fehler-ID	20060203
5	Importing	ERRORPARAM_AF	Call by reference	☑	Type reference (TYPE)	SXMSALERTAFERRPARAM_T		Error Parameters for AF	20060203
6	Importing	ERRORTEXT_AF	Call by reference	☑	Type reference (TYPE)	STRING			20060203
7	Importing	ERROR_CODE_IE	Call by reference	☑	Type reference (TYPE)	STRING			20060203
8	Importing	EXTMSGGUID	Call by reference	☑	Type reference (TYPE)	SXMSMGUIDC		SXMS: Message-Id	20091014
9	Importing	HOST	Call by reference	☐	Type reference (TYPE)	SY-HOST		R/3-System, Name des Applikationsservers	20060203
10	Importing	MDTURL	Call by reference	☑	Type reference (TYPE)	STRING			20060203
11	Importing	MDTURL_SECURE	Call by reference	☑	Type reference (TYPE)	STRING			20060203
12	Importing	MSGGUID	Call by reference	☑	Type reference (TYPE)	SXMSMGUIDC		Log-Guid	20060203
13	Importing	RECEIVER	Call by reference	☑	Type reference (TYPE)	SXI_FROMORTO		XI: Adresse (Party/Service) & Interface	20060203
14	Importing	ROLE	Call by reference	☐	Type reference (TYPE)	CHAR2		Komponente der Versionsnummer	20060203
15	Importing	SENDER	Call by reference	☑	Type reference (TYPE)	SXI_FROMORTO		XI: Adresse (Party/Service) & Interface	20060203
16	Importing	SYSID	Call by reference	☐	Type reference (TYPE)	SY-SYSID		R/3-System, Name des R/3-Systems	20060203
17	Importing	USERDEFATTR	Call by reference	☑	Type reference (TYPE)	SXMSALERTUSERDEFATTR_T		Name/Wert für benutzerdefinierte Message Attribute	20100105

Method CONSTRUCTOR on class CL_XI_ALERT has no exception.

Method CREATE_ALERT Signature

Method CREATE_ALERT on class CL_XI_ALERT has no parameter.
Method CREATE_ALERT on class CL_XI_ALERT has no exception.

Method FILL_ALERT_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTAINER	Value transfer	☐	Type reference (TYPE)	SXMSALERTSWCONT_T		Container Variablen	20060203
2	Importing	RULE	Call by reference	☑	Type reference (TYPE)	SXMSALERTRULES		Regeln zur Alertgenerierung: MsgHeader -> AlertKategorie	20060203

Method FILL_ALERT_CONTAINER on class CL_XI_ALERT has no exception.

Method GET_MD5_FROM_ERRORTXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MD5HASH	Value transfer	☐	Type reference (TYPE)	SXMSCHAR32		Characterfeld der Länge 32	20060203

Method GET_MD5_FROM_ERRORTXT on class CL_XI_ALERT has no exception.

Method HAS_ACTIVE_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RULE_FOUND	Value transfer	☐	Type reference (TYPE)	BOOLEAN_01		Boolsche Variable ('1'=true,'0'=false)	20060203

Method HAS_ACTIVE_RULE on class CL_XI_ALERT has no exception.

Method SUPPRESS_TIMEOUT_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALERT_CRETION_TIME	Call by reference	☐	Type reference (TYPE)	SALRTDCRET		Zeitstempel für das Auslösen eines Alerts	20130320
2	Returning	TIMEOUT_EXPIRED	Value transfer	☐	Type reference (TYPE)	BOOLEAN_01		Boolsche Variable ('1'=true,'0'=false)	20130320

Method SUPPRESS_TIMEOUT_CHECK on class CL_XI_ALERT has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	731