SAP ABAP Class CL_BATCH_EVENT (Background Processing: Background Processing Event)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-BTC (Application Component) Background Processing
     ⤷ SBTI_EVTHIST (Package) Event History of Background Processing

Properties

Class	CL_BATCH_EVENT
Short Description	Background Processing: Background Processing Event
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SBTI_EVTHIST	Event History of Background Processing
Created	20050811	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	T	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_BATCH_EVENT has no interface implemented.

Friends

Class CL_BATCH_EVENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	EVENT_EVTHIST_CRIT_ACTIVATED	Constant	Public	☐	Type reference (TYPE)	BTCEVENTID	'SAP_EVTHIST_CRITERIA_ACTIVATED'	The event 'SAP_EVTHIST_CRITERIA_ACTIVATED'	20051013
2	EVENT_SAP_END_OF_JOB	Constant	Public	☐	Type reference (TYPE)	BTCEVENTID	'SAP_END_OF_JOB'	The event 'SAP_END_OF_JOB'	20050811
3	EVENT_SAP_SYSTEM_START	Constant	Public	☐	Type reference (TYPE)	BTCEVENTID	'SAP_SYSTEM_START'	The event 'SAP_SYSTEM_START'	20050811
4	EVENT_SAP_SYSTEM_STOP	Constant	Public	☐	Type reference (TYPE)	BTCEVENTID	'SAP_SYSTEM_STOP'	The event 'SAP_SYSTEM_STOP'	20050814
5	PROG_BTC_RAISE_EVENT	Constant	Public	☐	Type reference (TYPE)	SYREPID	'BTC_EVENT_RAISE'	ABAP Program: Current Main Program	20060130
6	SLG_RAISE_FAILED	Constant	Public	☐	Type reference (TYPE)	CHAR3	'EHQ'	System Log: The triggering of an event failed	20050811
7	SLG_RAISE_FAILED_EOJ	Constant	Public	☐	Type reference (TYPE)	CHAR3	'EH4'	System Log: The triggering of SAP_END_OF_JOB failed	20050831
8	SLG_UNKNOWN_SERVER	Constant	Public	☐	Type reference (TYPE)	CHAR3	'EHP'	System Log: Unknown Server	20050817
9	SYSTEM_PREFIX	Constant	Public	☐	Type reference (TYPE)	BTCEVENTID	'SAP_'	Prefix for System Events	20050817

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_AS_JOBSTEP	Static method	Public	Method	Schedules Triggering of an Event in Background (Last Step)	20060130
2	CHANGE	Static method	Public	Method	Changes the Definition of an Event	20050818
3	CHECK_AUTHORITY	Static method	Public	Method	Determines what authorizations the user has	20050811
4	CREATE	Static method	Public	Method	Creates an event	20050811
5	DELETE	Static method	Public	Method	Deletes an event	20050811
6	DEQUEUE	Static method	Public	Method	Locks an event	20050830
7	ENQUEUE	Static method	Public	Method	Unlocks an event	20050830
8	GET	Static method	Public	Method	Returns details of the definition of an event	20050812
9	GET_ALL	Static method	Public	Method	Returns details of the definitions of all events	20050831
10	INSERT_AS_JOBSTEP	Static method	Public	Method	Schedules the triggering of an event in the background	20060130
11	INSERT_IN_TRANSPORT	Static method	Public	Method	Adds an event to a transport	20050913
12	RAISE	Static method	Public	Method	Triggers an event	20050811
13	WRITE_RAISER_INFO	Static method	Private	Method	Writes to the trace who triggered the event	20111107

Events

Class CL_BATCH_EVENT has no event.

Types

Class CL_BATCH_EVENT has no local type.

Method Signatures

Method ADD_AS_JOBSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20060130
2	Importing	I_EVENTPARM	Call by reference	☑	Type reference (TYPE)	BTCEVTPARM		Parameter eines Batch-Events (z.B. Jobname/Jobcount )	20060130
3	Importing	I_IGNORE_INCORRECT_SERVER	Call by reference	☐	Type reference (TYPE)	BOOLEAN	'X'	boolsche Variable (X=true, -=false, space=unknown)	20060130
4	Importing	I_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT		Kennummer eines Jobs	20060327
5	Importing	I_JOBNAME	Call by reference	☐	Type reference (TYPE)	BTCJOB		Schlüssel fuer Job-Log Verzeichnis bzw. Batch-Job Tabelle	20060327
6	Importing	I_SERVER	Call by reference	☑	Type reference (TYPE)	MSNAME2		Name des Applikationsservers	20060130
7	Importing	I_STATIC_PARAM	Call by reference	☐	Type reference (TYPE)	BOOLEAN	'X'	boolsche Variable (X=true, -=false, space=unknown)	20060207

#	Exception	Resumable	Description	Created on
1	EXCPT_SUBMIT_FAILED	☐	Das Einfügen des neuen Steps ist misslungen	20060130
2	EXCPT_UNKNOWN_JOB	☐	Kein Job entspricht den angegebenen Jobdaten	20060130

Method CHANGE 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)	BTCEVTCOMT			20050818
2	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID			20050818

#	Exception	Resumable	Description	Created on
1	EXCPT_EVENT_ALREADY_LOCKED	☐	Das Event ist gesperrt	20050831
2	EXCPT_LOCK_SYSTEM_FAILED	☐	Fehler des Sperrhandlers	20050831
3	EXCPT_NO_AUTHORITY	☐	Keine Pflegeberechtigung	20050818
4	EXCPT_UNKNOWN_EVENT	☐	Der angegebene Name ist unbekannt	20050818
5	EXCPT_UPDATE_FAILED	☐	Fehler beim Ändern eines Events	20050818

Method CHECK_AUTHORITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	I_CHANGE	Call by reference	☑	Type reference (TYPE)	BTCEVTAUTHCHANGE		Batch Events: Berechtigung zum Ändern eines Events	20051118
2	Changing	I_CREATE	Call by reference	☑	Type reference (TYPE)	BTCEVTAUTHCREATE		Batch Events: Berechtigung zum Anlegen eines Events	20051118
3	Changing	I_DELETE	Call by reference	☑	Type reference (TYPE)	BTCEVTAUTHDELETE		Batch Events: Berechtigung zum Löschen eines Events	20051118
4	Changing	I_EVENTID	Call by reference	☑	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20051118
5	Changing	I_RAISE	Call by reference	☑	Type reference (TYPE)	BTCEVTAUTHRAISE		Batch Events: Berechtigung zum Auslösen eines Events	20051118
6	Changing	I_TRANSPORT	Call by reference	☑	Type reference (TYPE)	BTCEVTAUTHTRANSPORT		Batch Events: Berechtigung zum Transortieren eines Events	20051118
7	Importing	I_USER	Call by reference	☑	Type reference (TYPE)	SYUNAME		Benutzername	20051118

#	Exception	Resumable	Description	Created on
1	EXCPT_UNKNOWN_USER	☐	Der angegebene Benutzer ist unbekannt	20051122

Method CREATE 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)	BTCEVTCOMT		Dokumentation (Beschreibung) einer EventId	20050811
2	Changing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20050811
3	Importing	I_SYSTEM	Call by reference	☐	Type reference (TYPE)	BTCEVENTTYPE		boolsche Variable (X=true, -=false, space=unknown)	20050811

#	Exception	Resumable	Description	Created on
1	EXCPT_ALREADY_EXISTS	☐	Es existiert bereits ein Event mit dem gleichen Namen	20050811
2	EXCPT_EMPTY_NAME	☐	Der angegebene Name ist leer	20051122
3	EXCPT_EVENT_ALREADY_LOCKED	☐	Das Event ist gesperrt	20050830
4	EXCPT_INSERT_FAILED	☐	Fehler beim Abspeichern eines neuen Events	20050811
5	EXCPT_INVALID_NAME	☐	Der Name des Events entspicht der Namenkonvention nicht	20050812
6	EXCPT_LOCK_SYSTEM_FAILED	☐	Fehler des Sperrhandlers	20050830
7	EXCPT_NO_AUTHORITY	☐	Keine Pflegeberechtigung	20050812

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20050811

#	Exception	Resumable	Description	Created on
1	EXCPT_DELETE_FAILED	☐	Fehler beim Löschen eines Events	20050811
2	EXCPT_EVENT_ALREADY_LOCKED	☐	Das Event ist gesperrt	20050831
3	EXCPT_EVENT_IN_USE	☐	Die Prüfselektion ergibt, daß das Event noch benutzt wird	20050830
4	EXCPT_JOB_SELECTION_FAILED	☐	Die Prüfselektion von Jobs ist misslungen	20050830
5	EXCPT_LOCK_SYSTEM_FAILED	☐	Fehler des Sperrhandlers	20050831
6	EXCPT_NO_AUTHORITY	☐	Keine Pflegeberechtigung	20050812
7	EXCPT_UNKNOWN_EVENT	☐	Der angegebene Name ist unbekannt	20050811

Method DEQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID			20050830

Method DEQUEUE on class CL_BATCH_EVENT has no exception.

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID			20050830

#	Exception	Resumable	Description	Created on
1	EXCPT_EVENT_ALREADY_LOCKED	☐	Das Event ist gesperrt	20050830
2	EXCPT_LOCK_SYSTEM_FAILED	☐	Fehler des Sperrhandlers	20050830

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DATE	Call by reference	☐	Type reference (TYPE)	SYDATUM		Aktuelles Datum des Applikationsservers	20050812
2	Exporting	E_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	BTCEVTCOMT		Dokumentation (Beschreibung) einer EventId	20050812
3	Exporting	E_SYSTEM	Call by reference	☐	Type reference (TYPE)	BTCEVENTTYPE		Batch Events: Typ eines Events	20050812
4	Exporting	E_TIME	Call by reference	☐	Type reference (TYPE)	SYUZEIT		Aktuelle Uhrzeit des Applikationsservers	20050812
5	Exporting	E_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		Benutzername	20050812
6	Changing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20050812

#	Exception	Resumable	Description	Created on
1	EXCPT_UNKNOWN_EVENT	☐	Der angegebene Name ist unbekannt	20050812

Method GET_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EVENTS	Call by reference	☐	Type reference (TYPE)	BTC_T_EVTINFO		Batch: Tabellentyp für BTCEVTINFO	20050831
2	Importing	I_EVTID_MASK	Call by reference	☐	Type reference (TYPE)	BTCEVENTID	'%'	Ereignisse der Hintergrundverarbeitung	20071002

Method GET_ALL on class CL_BATCH_EVENT has no exception.

Method INSERT_AS_JOBSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	BTCJOBCNT		Kennummer eines Jobs	20060327
2	Importing	I_JOBNAME	Call by reference	☐	Type reference (TYPE)	BTCJOB		Name eines Hintergrundjobs	20060327
3	Importing	I_STEP_NUM	Call by reference	☐	Type reference (TYPE)	BTCSTEPCNT	0	Kennummer eines Job-Steps	20060130
4	Importing	I_VARIANT	Call by reference	☐	Type reference (TYPE)	RALDB_VARI		Variantenname	20060130

#	Exception	Resumable	Description	Created on
1	EXCPT_INVALID_VARIANT	☐	Die angegebene Variante ist ungültig	20060130
2	EXCPT_SUBMIT_FAILED	☐	Das Einfügen des neuen Steps ist misslungen	20060130
3	EXCPT_UNKNOWN_JOB	☐	Kein Job entspricht den angegebenen Jobdaten	20060130
4	EXCPT_WRONG_STEP_NUM	☐	Die gewünschte Stepnummer ist unerreichbar	20060130

Method INSERT_IN_TRANSPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20050913
2	Importing	I_TASK	Call by reference	☐	Type reference (TYPE)	TRKORR		Auftrag/Aufgabe	20050913

#	Exception	Resumable	Description	Created on
1	EXCPT_APPEND_FAILED	☐	Fehler beim Anhängen eines Events an den Transport	20050913
2	EXCPT_NO_AUTHORITY	☐	Keine Pflegeberechtigung	20050913
3	EXCPT_UNKNOWN_EVENT	☐	Der angegebene Name ist unbekannt	20050913

Method RAISE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20050812
2	Importing	I_EVENTPARM	Call by reference	☑	Type reference (TYPE)	BTCEVTPARM		Parameter eines Batch-Events (z.B. Jobname/Jobcount )	20050811
3	Importing	I_IGNORE_INCORRECT_SERVER	Call by reference	☐	Type reference (TYPE)	BOOLEAN	'X'	boolsche Variable (X=true, -=false, space=unknown)	20050811
4	Importing	I_SERVER	Call by reference	☑	Type reference (TYPE)	MSNAME2		Name des Applikationsservers	20050811

#	Exception	Resumable	Description	Created on
1	EXCPT_NO_AUTHORITY	☐	Keine Pflegeberechtigung	20051118
2	EXCPT_RAISE_FAILED	☐	Das Auslösen des Events ist misslungen	20050811
3	EXCPT_RAISE_FORBIDDEN	☐	Das Auslösen des angegebenen Events ist verboten	20050811
4	EXCPT_SERVER_ACCEPTS_NO_EVENTS	☐	Der Zielserver bearbeitet keine Events	20050811
5	EXCPT_UNKNOWN_EVENT	☐	Der angegebene Name ist unbekannt	20050812

Method WRITE_RAISER_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENTID	Call by reference	☐	Type reference (TYPE)	BTCEVENTID		Ereignisse der Hintergrundverarbeitung	20111107
2	Importing	I_EVENTPARM	Call by reference	☑	Type reference (TYPE)	BTCEVTPARM		Parameter eines Batch-Events (z.B. Jobname/Jobcount )	20111107

Method WRITE_RAISER_INFO on class CL_BATCH_EVENT has no exception.

History

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