SAP ABAP Class CL_PERIODIC_BG_MONITORING (Monitoring of Periodic Background Activity)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CST-EQ (Application Component) Enqueue
     ⤷ S_PBG_MON (Package) Monitoring of Periodic Background Activities

Properties

Class	CL_PERIODIC_BG_MONITORING
Short Description	Monitoring of Periodic Background Activity
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_PBG_MON	Monitoring of Periodic Background Activities
Created	20050117	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_PERIODIC_BG_MONITORING has no forward declaration.

Interfaces

Class CL_PERIODIC_BG_MONITORING has no interface implemented.

Friends

Class CL_PERIODIC_BG_MONITORING has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	END_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20050118
2	FUNCTION_INDICATOR	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR		Status of Function to Be Monitored	20050117
3	FUNCTION_TYPE	Static Attribute	Public	☑	Type reference (TYPE)	TEXT80		Type for Function Module Name	20050301
4	INDICATORS	Instance attribute	Private	☐	Type reference (TYPE)	LOCKTAB		List of Indicators	20050118
5	INDICATOR_TYPE	Static Attribute	Public	☑	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR		Type of Indicator	20050224
6	INITIAL_CHECK_INTERVAL	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-CHECK_INTERVAL		Numeric fifteen-digit value	20050118
7	INITIAL_DESTINATION	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-DESTINATION		Text length 20	20050118
8	INITIAL_FUNCTION	Instance attribute	Private	☐	Attribute reference (LIKE)	FUNCTION_TYPE		Function Module Name	20050301
9	INITIAL_INSTANCE	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Instance Number	20050118
10	INITIAL_INSTANCES	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Number of Instances	20050118
11	INITIAL_NAME	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-NAME		Name of Background Activity	20050118
12	INIT_DONE	Instance attribute	Private	☐	Type reference (TYPE)	I		Execute Initialization	20050301
13	IS_NUMBER	Constant	Private	☐	Type reference (TYPE)	TEXT40	'0123456789 '	Numbers and Spaces	20050223
14	LOCK_READ_WILDCARD	Static Attribute	Private	☐	Type reference (TYPE)	TEXT20	'*'	Wildcard To Read Locks	20050118
15	LOCK_WILDCARD	Static Attribute	Private	☐	Type reference (TYPE)	TEXT80		Wildcard for Generic Locks	20050118
16	MAX_RUN_PER_INSTANCE	Instance attribute	Private	☐	Type reference (TYPE)	I	2	Maximum Number of Processes Running on Each Instance	20050224
17	RTC_INSTANCES_INCOMPLETE	Constant	Private	☐	Type reference (TYPE)	I	11		20050128
18	RTC_INSTANCE_IN_SHUTDOWN_MODE	Instance attribute	Private	☐	Type reference (TYPE)	I	12	Instance is in shutdown mode	20081022
19	RTC_LOCK_FAILED	Constant	Private	☐	Type reference (TYPE)	I	1		20050128
20	RTC_LOCK_NOT_FOUND	Constant	Private	☐	Type reference (TYPE)	I	2	Lock not found	20050128
21	RTC_OK	Constant	Public	☐	Type reference (TYPE)	I	0	Return Code OK	20050128
22	RUN_INDICATOR	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR		Indicator in the Lock Table for Run Permission	20050223
23	START_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20050118
24	STATE_BUSY	Constant	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-STATE	'busy'	Status 'Busy'	20050126
25	STATE_IDLE	Constant	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-STATE	'idle'	Status 'Idle'	20050126
26	STATE_RUN	Constant	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-STATE	'run'	Permission for Remaining Active	20050223
27	UPD_INDICATOR	Instance attribute	Private	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR		Indicator in Lock Table for Live Instances	20050118

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	INITIALIZE_FOR_MONITORING	Instance method	Public	Method	Initializes object for monitoring	20050118
2	INITIALIZE_FOR_PERIODIC_BG	Instance method	Public	Method	Initializes object for periodic execution	20050118
3	MONITOR	Instance method	Public	Method	Monitor for Background Activities	20050118
4	MONITOR_ALL_INSTANCES	Instance method	Private	Method	Monitor for All Instances	20050126
5	OWN_SERVER_OPERATIONAL	Instance method	Private	Method	Check if own server is fully operational, if yes return 1	20081022
6	POST_INSTANCE_INDICATOR	Instance method	Private	Method	Writes runtime indicator of background activity	20050126
7	POST_STARTUP_INDICATOR	Instance method	Private	Method	Writes runtime indicator of background activity	20050126
8	READ_INSTANCE_INDICATORS	Instance method	Private	Method	Reads the number of indicators of an instance	20050224
9	REMOVE_INSTANCE_INDICATOR	Instance method	Private	Method	Writes runtime indicator of background activity	20081022
10	START_BG_VIA_ARFC	Instance method	Private	Method		20050128
11	START_INSTANCE	Instance method	Private	Method	Monitor for an Instance Number	20050128
12	UPDATE_AT_END	Instance method	Public	Method	Refreshes Indicator for Background Activity	20050118
13	UPDATE_AT_START	Instance method	Public	Method	Refreshes Indicator for Background Activity	20050118
14	UPDATE_INSTANCE_INDICATOR	Instance method	Private	Method	Writes runtime indicator of background activity	20050118

Events

Class CL_PERIODIC_BG_MONITORING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LOCKTAB	Public	See coding			20050118	LOCKTAB type table of seqg3

Method Signatures

Method INITIALIZE_FOR_MONITORING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHECK_INTERVAL	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-CHECK_INTERVAL		Überwachungsintervall in Sekunden	20050118
2	Importing	DESTINATION	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-DESTINATION		Destination	20050118
3	Importing	FUNCTION	Value transfer	☐	Attribute reference (LIKE)	FUNCTION_TYPE		Funktionsbaustein	20050301
4	Importing	INSTANCES	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Anzahl der Hintergrund-Instanzen	20050118
5	Importing	NAME	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-NAME		Name der Hintergrund-Aktivität	20050118
6	Returning	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK		Returncode OK	20050301

Method INITIALIZE_FOR_MONITORING on class CL_PERIODIC_BG_MONITORING has no exception.

Method INITIALIZE_FOR_PERIODIC_BG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHECK_INTERVAL	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-CHECK_INTERVAL		Überwachungsintervall in Sekunden	20050118
2	Importing	DESTINATION	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-DESTINATION		Destination	20050118
3	Importing	INSTANCE	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Nummer der Hintergrund-Instanz	20050118
4	Importing	NAME	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-NAME		Name der Hintergrund-Aktivität	20050118
5	Returning	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK		Returncode	20050301

Method INITIALIZE_FOR_PERIODIC_BG on class CL_PERIODIC_BG_MONITORING has no exception.

Method MONITOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK		Returncode	20050301

Method MONITOR on class CL_PERIODIC_BG_MONITORING has no exception.

Method MONITOR_ALL_INSTANCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK			20050128

Method MONITOR_ALL_INSTANCES on class CL_PERIODIC_BG_MONITORING has no exception.

Method OWN_SERVER_OPERATIONAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	OPERATIONAL	Value transfer	☐	Type reference (TYPE)	I		0 if server is not fully operational	20081022

Method OWN_SERVER_OPERATIONAL on class CL_PERIODIC_BG_MONITORING has no exception.

Method POST_INSTANCE_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK			20050128

Method POST_INSTANCE_INDICATOR on class CL_PERIODIC_BG_MONITORING has no exception.

Method POST_STARTUP_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INSTANCE	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Nicht näher def. Bereich, evtl. für Patchlevels verwendbar	20050128
2	Exporting	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK			20050128

Method POST_STARTUP_INDICATOR on class CL_PERIODIC_BG_MONITORING has no exception.

Method READ_INSTANCE_INDICATORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	INDICATOR	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR		Structure for locking of periodic backgreound aktivities	20050224
2	Importing	INSTANCE	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Instanz	20050224
3	Exporting	OUTSTANDING_INSTANCES	Value transfer	☐	Type reference (TYPE)	I		Ausstehende Instanzen mit Check-Intervall Ueberschreitung	20050224
4	Exporting	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK		Returncode	20050224
5	Exporting	VITAL_INSTANCES	Value transfer	☐	Type reference (TYPE)	I		Lebendige Instanzen mit aktualisiertem Indikator	20050224

Method READ_INSTANCE_INDICATORS on class CL_PERIODIC_BG_MONITORING has no exception.

Method REMOVE_INSTANCE_INDICATOR Signature

Method REMOVE_INSTANCE_INDICATOR on class CL_PERIODIC_BG_MONITORING has no parameter.
Method REMOVE_INSTANCE_INDICATOR on class CL_PERIODIC_BG_MONITORING has no exception.

Method START_BG_VIA_ARFC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INSTANCE	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Nicht näher def. Bereich, evtl. für Patchlevels verwendbar	20050128

Method START_BG_VIA_ARFC on class CL_PERIODIC_BG_MONITORING has no exception.

Method START_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INSTANCE	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-INSTANCE		Nicht näher def. Bereich, evtl. für Patchlevels verwendbar	20050128
2	Exporting	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK			20050128

Method START_INSTANCE on class CL_PERIODIC_BG_MONITORING has no exception.

Method UPDATE_AT_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RTC	Value transfer	☐	Attribute reference (LIKE)	RTC_OK			20050218

Method UPDATE_AT_END on class CL_PERIODIC_BG_MONITORING has no exception.

Method UPDATE_AT_START Signature

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

Method UPDATE_AT_START on class CL_PERIODIC_BG_MONITORING has no exception.

Method UPDATE_INSTANCE_INDICATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUSY_TIME	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-BUSY_TIME		Feld vom Typ TIMS	20050118
2	Exporting	RTC	Value transfer	☐	Type reference (TYPE)	I		Returncode	20050128
3	Importing	STATE	Value transfer	☐	Type reference (TYPE)	SPBGM_FUNCTION_INDICATOR-STATE		Characterfeld der Länge 10	20050118

Method UPDATE_INSTANCE_INDICATOR on class CL_PERIODIC_BG_MONITORING has no exception.

History

Last changed by/on	SAP	20090618
SAP Release Created in	710