SAP ABAP Class CL_SPI_AS_PROCESS_PATH_ALERTIN (Process Completion with Event Generation (Alerting))
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
     ⤷ SPI3 (Package) Central: Process Store and Assembler
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_SPI_AS_PROCESS_PATH 20100721
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SPI_PROCESS_PATH_ALERTING Enhancement of Alerting Process Instance 20100802
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_SPI_DEMO_AS_PROCESS Demo Usage of Assembler BAdI 20100922
2 Inheritance (c INHERITING FROM c_ref)  CL_SPI_TEST_AS_PROCESS Test assembler exit for alerting 20100729
Properties
Class CL_SPI_AS_PROCESS_PATH_ALERTIN  
Short Description Process Completion with Event Generation (Alerting)    
Super Class CL_SPI_AS_PROCESS_PATH  
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SPI3   Central: Process Store and Assembler 
Created 20100721   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 SPI Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_SPI_PROCESS_PATH_ALERTING Enhancement of Alerting Process Instance 20100802
Friends
Class CL_SPI_AS_PROCESS_PATH_ALERTIN has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GT_1STEP_EVENTS Instance attribute Private Type reference (TYPE) TT_SSPICSE1 One-Step Events per Instance 20100721
2 GT_2STEP_EVENTS Instance attribute Private Type reference (TYPE) TT_SSPICSE2 Response-Time Events per Instance 20100721
Methods
# Method Level Visibility Method type Description Created on
1 ARE_EVENTS_IN_STEPS Instance method Private Method Are there events in subprocesses? 20100721
2 CHECK_1STEP_METRIC Instance method Protected Method Check One-Step Metric (Status) 20100721
3 CHECK_1STEP_METRIC_TIMEOUT Instance method Protected Method Check for timeout for the one-step metric 20100721
4 CHECK_2STEP_METRIC Instance method Protected Method Check Two-Step Metric (Response Time) 20100721
5 CHECK_FOR_FORCED_FINISH Instance method Private Method Check if There is a Forced Finish for a Two-Step Event 20100721
6 CREATE_1STEP_EVENT Instance method Protected Method Create One-Step Event (Status Event) 20100721
7 CREATE_2STEP_EVENT Instance method Protected Method Create Two-Step Event (Response-Time Event) 20100721
8 GET_RT_EVENT_VALUE Instance method Protected Method Returns the event value; = 0 if not event to be triggered 20100729
9 GET_RT_TIMEOUT_TIMESTAMP Instance method Protected Method Returns the time at which the timeout occurred 20100729
10 HOW_MANY_FIRST_STEPS Instance method Private Method Checks how many "first" steps of an RT metric exist 20100721
11 IS_SECOND_STEP_MISSING Instance method Private Method Checks whether step 1 expects a step 2 20100831
12 IS_STEP_AVAILABLE Instance method Private Method Checks if (at least) one step from metric is in the instance 20100721
Events
Class CL_SPI_AS_PROCESS_PATH_ALERTIN has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TT_SSPICSE1 Public See coding 20100721
2 TT_SSPICSE2 Public See coding 20100721
Method Signatures

Method ARE_EVENTS_IN_STEPS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_EVENT Value transfer Type reference (TYPE) SPIBOOL SPI Global: Boolscher Wert 20100721

Method ARE_EVENTS_IN_STEPS on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.

Method CHECK_1STEP_METRIC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Metricdaten aus dem Customizing 20100721
2 Returning RP_RESULT Value transfer Type reference (TYPE) SPIBOOL Event auslösen? 20100721
# Exception Resumable Description Created on
1 CX_SPI_ADMIN Fehler im Zugriff auf Administrationsdaten 20100721
2 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20100721

Method CHECK_1STEP_METRIC_TIMEOUT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EP_STEP_MISSING Call by reference Type reference (TYPE) SPIBOOL Es wird noch ein Schritt der Metrik erwartet 20100831
2 Exporting EP_TIMEOUT_REACHED Call by reference Type reference (TYPE) SPIBOOL Time Out der 1-Schritt-Metrik erreicht 20100831
3 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Metricdaten aus dem Customizing 20100721
# Exception Resumable Description Created on
1 CX_SPI_ADMIN Fehler im Zugriff auf Administrationsdaten 20100721
2 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20100721

Method CHECK_2STEP_METRIC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EP_DELINST Call by reference Type reference (TYPE) SPIBOOL Instanz löschen? 20100721
2 Exporting EP_EVENT Call by reference Type reference (TYPE) SPIBOOL Event auslösen? 20100721
3 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Metricdaten aus dem Customizing 20100721
# Exception Resumable Description Created on
1 CX_SPI_ADMIN Fehler im Zugriff auf Administrationsdaten 20100721
2 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20100721

Method CHECK_FOR_FORCED_FINISH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_STEPID2 Call by reference Type reference (TYPE) SPIPRSTID SPI: ID eines Prozessschrittes 20100721
2 Importing IS_STEP1 Call by reference Type reference (TYPE) SSPIPRST Schritt 1 der Metrik 20100804
3 Returning RP_RESULT Value transfer Type reference (TYPE) SPIBOOL SPI Global: Boolscher Wert 20100721

Method CHECK_FOR_FORCED_FINISH on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.

Method CREATE_1STEP_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Referenz auf Metrik 20100721
2 Importing IO_TR Call by reference Object reference (TYPE REF TO) IF_SPI_TRACKING_RECORD Tracking Record, bei 'echtem' Event 20100721
3 Importing IP_BDF_REACHED Call by reference Type reference (TYPE) SPIBOOL SPI_FALSE Für BDF-Event 20100721
4 Importing IP_STEPID Call by reference Type reference (TYPE) SPIPRSTID ID des Prozessschrittes bei Time Out 20100721

Method CREATE_1STEP_EVENT on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.

Method CREATE_2STEP_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Referenz auf Metrik 20100721
2 Importing IO_TR1 Call by reference Object reference (TYPE REF TO) IF_SPI_TRACKING_RECORD BPT: Tracking Record 20100721
3 Importing IO_TR2 Call by reference Object reference (TYPE REF TO) IF_SPI_TRACKING_RECORD BPT: Tracking Record 20100721
4 Importing IP_BDF_REACHED Call by reference Type reference (TYPE) SPIBOOL SPI_FALSE SPI Global: Boolscher Wert 20100721
5 Importing IP_VALUE Call by reference Type reference (TYPE) SPIRTMVAL PMI: Wert einer Laufzeitmessung in Sekunden 20100721
# Exception Resumable Description Created on
1 TR1_MISSING Referenz auf TR1 fehlt! 20100721

Method GET_RT_EVENT_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_STEP1 Call by reference Object reference (TYPE REF TO) IF_SPI_TRACKING_RECORD Tracking Record, Step 1 der RT-Metrik 20100729
2 Importing II_STEP2 Call by reference Object reference (TYPE REF TO) IF_SPI_TRACKING_RECORD BPT: Tracking Record, Step 2 der RT-Metrik 20100729
3 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Metricdaten aus dem Customizing 20100729
4 Returning RP_RESULT Value transfer Type reference (TYPE) I Eventwert; Null/initial, wenn kein Event 20100729

Method GET_RT_EVENT_VALUE on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.

Method GET_RT_TIMEOUT_TIMESTAMP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_STEP1 Call by reference Object reference (TYPE REF TO) IF_SPI_TRACKING_RECORD BPT: Tracking Record, Step 1 der Metrik 20100729
2 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Metricdaten aus dem Customizing 20100729
3 Returning RP_RESULT Value transfer Type reference (TYPE) TIMESTAMPL UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun) 20100729

Method GET_RT_TIMEOUT_TIMESTAMP on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.

Method HOW_MANY_FIRST_STEPS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Metricdaten aus dem Customizing 20100721
2 Returning RP_RESULT Value transfer Type reference (TYPE) I Anzahl Schritte 20100721

Method HOW_MANY_FIRST_STEPS on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.

Method IS_SECOND_STEP_MISSING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_STEPID2 Call by reference Type reference (TYPE) SPIPRSTID ID des Schrittes 2 der Metrik/des Schrittes der 1-Schritt-M. 20100831
2 Importing IS_STEP1 Call by reference Type reference (TYPE) SSPIPRST Schritt 1 der Metrik/Startschritt bei 1-Schritt-Metrik 20100831
3 Returning RP_RESULT Value transfer Type reference (TYPE) SPIBOOL SPI Global: Boolscher Wert 20100831

Method IS_SECOND_STEP_MISSING on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.

Method IS_STEP_AVAILABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_METRIC Call by reference Object reference (TYPE REF TO) CL_SPI_CU_METRIC Metricdaten aus dem Customizing 20100721
2 Returning RP_RESULT Value transfer Type reference (TYPE) SPIBOOL SPI Global: Boolscher Wert 20100721

Method IS_STEP_AVAILABLE on class CL_SPI_AS_PROCESS_PATH_ALERTIN has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 703