SAP ABAP Class CL_SPI_PROCESS_INST (Process Instance)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
     SPI6 (Package) Central: API Process Information
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SPI_COMMON Common functionality 20020704
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SPI_COMPARABLE Object comparison 20020704
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_SPI_PROCESS_INST PMI: Process Instance Interface 20030702
Properties
Class CL_SPI_PROCESS_INST  
Short Description Process Instance    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SPI6   Central: API Process Information 
Created 20020704   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_COMMON Common functionality 20020704
2 IF_SPI_COMPARABLE Object comparison 20020704
3 IF_SPI_PROCESS_INST PMI: Process Instance Interface 20030702
Friends
# Friend Modeled only Created on Description
1 CL_SPI_PAYLOAD_TOOL 20030718 Tool Implementation with Fixed Attribute Values
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GO_CACHE Instance attribute Private Object reference (TYPE REF TO) CL_SPI_ATTRIBUTE_CACHE Cache for Attribute Instances 20021007
2 GO_PROCDEF Instance attribute Protected Object reference (TYPE REF TO) CL_SPI_PROCESS Process Definition from Customizing 20020710
3 GO_ROOT Instance attribute Private Object reference (TYPE REF TO) CL_SPI_STEP_INST Value of GET_STEP_TREE 20030411
4 GS_HEADER Instance attribute Protected Type reference (TYPE) SSPICSPRHD SPI: Assembled Process Instances 20020719
5 GT_ATTR Instance attribute Protected Type reference (TYPE) TSPIATTR Table with attributes 20020823
6 GT_PAYLOAD Instance attribute Protected Type reference (TYPE) TSPIPLTR Payload Values of this Instance 20030718
7 GT_STEPSI Instance attribute Protected Type reference (TYPE) TSPISTEPI Table with instances of CL_SPI_STEP_INST 20020726
8 GT_TRANSI Instance attribute Protected Type reference (TYPE) TSPITRANSI Table with transition instances 20020729
9 G_DESCR Instance attribute Protected Type reference (TYPE) SPIINSTTXT SPI: Template for Process Instance Short Text 20020823
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor 20020710
2 EQUALS Instance method Public Method 20020710
3 FIND Static method Public Method Gets Process Instance GUIDs According to Certain Criteria 20030407
4 GET_AGGREGATED_ATTRIBUTES Instance method Public Method Returns Step Attributes Aggregated Over Multiple Steps 20030618
5 GET_ASM_STATUS Instance method Public Method Assembler-specific process instance status 20020730
6 GET_ATTRIBUTE Instance method Public Method 20020710
7 GET_ATTRIBUTES Instance method Public Method 20020710
8 GET_CREATION_TIME Instance method Public Method 20030722
9 GET_CREAT_TIME Instance method Public Method Process instance creation/change by assembler 20020730
10 GET_DEFINITION Instance method Public Method Process Definition 20020719
11 GET_DESCRIPTION Instance method Public Method 20020710
12 GET_DURATION Instance method Public Method Process duration (in seconds), if still open: initial 20020911
13 GET_END_TIME Instance method Public Method End time (UTC), if not available: initial 20020911
14 GET_EXPIRY_DATE Instance method Public Method Returns the Expiry date 20030711
15 GET_INSTANCES Static method Public Method Returns process instances in specified time period 20020719
16 GET_INST_GUID Instance method Public Method GUID of this process instance 20020730
17 GET_PAYLOAD Instance method Protected Method Returns Payload Data of All Steps 20030718
18 GET_PAYLOAD_VALUE Instance method Protected Method Returns Payload Value for Tracking GUID and Field Name 20030718
19 GET_START_TIME Instance method Public Method Start time (UTC) 20020911
20 GET_STEP Instance method Public Method Gets Step Instance for Tracking GUID 20030430
21 GET_STEPS Instance method Public Method Returns step instances 20020814
22 GET_STEP_TREE Instance method Public Method Gets First Step of Instance 20030411
23 GET_TEXT_ATTRIBUTE_VALUE Instance method Protected Method Determines attribute value of a text attribute 20020919
24 GET_TOP_PROCESS_STEP Instance method Public Method Gets step instances of top processes 20090814
25 GET_TRANSITIONS Instance method Public Method Gets Transition Instances 20030415
26 GET_TYPE_ID Instance method Public Method Type ID of this process instance 20021007
27 HEADER_DB_SELECT Instance method Private Method Read header fields from DB (if changed) 20021016
28 IS_COMPLETE Instance method Public Method Is process complete? 20020927
29 IS_FINISHED Instance method Public Method Is process finished? 20020927
30 MAKE_STEP Instance method Private Method Reuse/create step instance 20021017
31 MAKE_STEP_CHAIN Instance method Private Method Generate Linear Step Chain (Branch) 20030411
32 MAKE_STEP_TREE Instance method Private Method Build Process Instance 20030411
33 MAKE_TRANSITION Instance method Private Method Reuse/Create Transition Instance 20021018
34 REFRESH Instance method Private Method Re-read data from DB 20020912
35 STEPS_DB_SELECT Instance method Private Method Read steps from DB 20021016
Events
Class CL_SPI_PROCESS_INST has no event.
Types
Class CL_SPI_PROCESS_INST 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 IO_PDEF Value transfer Object reference (TYPE REF TO) CL_SPI_PROCESS Prozessdefinition aus dem Customizing 20020724
2 Importing IS_HEADER Call by reference Type reference (TYPE) SSPICSPRHD SPI: Assembled Process instances 20020724
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method EQUALS Signature

Method EQUALS on class CL_SPI_PROCESS_INST has no parameter.
Method EQUALS on class CL_SPI_PROCESS_INST has no exception.

Method FIND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ET_PROCESS_GUIDS Value transfer Type reference (TYPE) TSPIPRGUID Prozessinstanz-GUIDs 20030407
2 Importing IP_MAX_COUNT Call by reference Type reference (TYPE) I Einschränkung für die Treffermenge 20030407
3 Importing IP_PROCESS_ID Call by reference Type reference (TYPE) SPIPROCTP Prozesstyp 20030407
4 Importing IT_CONDITIONS Call by reference Type reference (TYPE) TSPIATTRAN Filterkriterien 20030407
# Exception Resumable Description Created on
1 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20040217

Method GET_AGGREGATED_ATTRIBUTES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_AGGREGATION_TYPE Call by reference Type reference (TYPE) SPIATTAGGR Aggregationsart 20030618
2 Importing IS_ID Call by reference Type reference (TYPE) SSPIATTID Struktur der Attribut ID 20030618
3 Importing IT_STEPS Call by reference Type reference (TYPE) TSPISTEPI Schritte über die aggregiert werden soll 20030618
4 Returning RP_ATTRIBUTE Value transfer Object reference (TYPE REF TO) IF_SPI_ATTRIBUTE Aggregationsattribut 20030618
# Exception Resumable Description Created on
1 CX_SPI_API PMI: API-Ausnahme 20030618
2 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20030618

Method GET_ASM_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_STAT Call by reference Type reference (TYPE) SSPIPROCST SPI: Status einer Prozessinstanz 20020730

Method GET_ASM_STATUS on class CL_SPI_PROCESS_INST has no exception.

Method GET_ATTRIBUTE Signature

Method GET_ATTRIBUTE on class CL_SPI_PROCESS_INST has no parameter.
Method GET_ATTRIBUTE on class CL_SPI_PROCESS_INST has no exception.

Method GET_ATTRIBUTES Signature

Method GET_ATTRIBUTES on class CL_SPI_PROCESS_INST has no parameter.
Method GET_ATTRIBUTES on class CL_SPI_PROCESS_INST has no exception.

Method GET_CREATION_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_CREATION_TIME Value transfer Type reference (TYPE) SPIINSTMP 20030722

Method GET_CREATION_TIME on class CL_SPI_PROCESS_INST has no exception.

Method GET_CREAT_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_TIME Value transfer Type reference (TYPE) SPIINSTMP SPI: Eingangszeitstempel Central Store 20020730
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method GET_DEFINITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_DEF Value transfer Object reference (TYPE REF TO) CL_SPI_PROCESS Prozessdefinition aus dem Customizing 20020719

Method GET_DEFINITION on class CL_SPI_PROCESS_INST has no exception.

Method GET_DESCRIPTION Signature

Method GET_DESCRIPTION on class CL_SPI_PROCESS_INST has no parameter.
Method GET_DESCRIPTION on class CL_SPI_PROCESS_INST has no exception.

Method GET_DURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_TIME Value transfer Type reference (TYPE) TIMESTAMPL UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun) 20020911
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method GET_END_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_TIME Value transfer Type reference (TYPE) TIMESTAMPL UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun) 20020911
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method GET_EXPIRY_DATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_EXPIRY_DATE Value transfer Type reference (TYPE) SPIRGEXPIRY 20030711

Method GET_EXPIRY_DATE on class CL_SPI_PROCESS_INST has no exception.

Method GET_INSTANCES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_INST Call by reference Type reference (TYPE) TSPIPROCI Tabelle mit Prozessinstanzen 20020719
2 Importing IO_SEARCH_FILTER Call by reference Object reference (TYPE REF TO) IF_SPI_SEARCH_FILTER 20030829
3 Importing IP_FIRST_N Call by reference Type reference (TYPE) INT4 Nur die ersten n Instanzen 20081023
4 Importing IP_LAST_N Call by reference Type reference (TYPE) INT4 Nur die letzten n Instanzen 20081023
5 Importing IP_TYPE Call by reference Type reference (TYPE) SPIPROCTP SPI: ID eines Prozesstypen 20020719
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method GET_INST_GUID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_GUID Value transfer Type reference (TYPE) SPIPRGUID SPI: GUID of a Process 20020730

Method GET_INST_GUID on class CL_SPI_PROCESS_INST has no exception.

Method GET_PAYLOAD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_PAYLOAD Value transfer Type reference (TYPE) TSPIPLTR Payloaddaten 20030718
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20030718
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20030718

Method GET_PAYLOAD_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_FLDNAM Call by reference Type reference (TYPE) SPIDFLDNAM Feldnamen 20030718
2 Importing IP_TRGUID Call by reference Type reference (TYPE) SPITRGUID Schrittinstanzid 20030718
3 Returning RP_VALUE Value transfer Type reference (TYPE) SPIATTVAL Feldwert 20030718
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20030718
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20030718

Method GET_START_TIME Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_TIME Value transfer Type reference (TYPE) TIMESTAMPL UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun) 20020911

Method GET_START_TIME on class CL_SPI_PROCESS_INST has no exception.

Method GET_STEP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_TRACKING_GUID Call by reference Type reference (TYPE) SPITRGUID Tracking ID 20030430
2 Returning RO_STEP Value transfer Object reference (TYPE REF TO) CL_SPI_STEP_INST Prozessschrittinstanz 20030430
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20030430
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20030430

Method GET_STEPS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_STEPSI Value transfer Type reference (TYPE) TSPISTEPI Tabelle mit Instanzen von CL_SPI_STEP_INST 20020814
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method GET_STEP_TREE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_STEP Value transfer Object reference (TYPE REF TO) CL_SPI_STEP_INST 20030411
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20030411
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20030411

Method GET_TEXT_ATTRIBUTE_VALUE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_LANGU Call by reference Type reference (TYPE) LANGU SY-LANGU Sprachenschlüssel 20020919
2 Importing IS_ATT Call by reference Type reference (TYPE) SSPIPDTA Textattribut 20020919
3 Returning RP_VALUE Value transfer Type reference (TYPE) STRING Attributwert 20020919
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021121

Method GET_TOP_PROCESS_STEP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_PROCESS_ID Call by reference Type reference (TYPE) SPIPROCTP SPI: ID eines Prozesstypen 20090814
2 Returning RO_STEP Value transfer Object reference (TYPE REF TO) CL_SPI_STEP_INST Prozessschrittinstanz 20090814
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20090814
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20090814

Method GET_TRANSITIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_TRANSI Value transfer Type reference (TYPE) TSPITRANSI 20030415
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20030415
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20030415

Method GET_TYPE_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_TYPE Value transfer Type reference (TYPE) SPIPROCTP SPI: ID eines Prozesstypen 20021007

Method GET_TYPE_ID on class CL_SPI_PROCESS_INST has no exception.

Method HEADER_DB_SELECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_HEADER Call by reference Type reference (TYPE) SSPICSPRHD SPI: Assembled Process instances 20021016

Method HEADER_DB_SELECT on class CL_SPI_PROCESS_INST has no exception.

Method IS_COMPLETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_BOOL Value transfer Type reference (TYPE) SPIBOOL SPI Global: Boolscher Wert 20020927
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method IS_FINISHED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_BOOL Value transfer Type reference (TYPE) SPIBOOL SPI Global: Boolscher Wert 20020927
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021120

Method MAKE_STEP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_STEP Call by reference Type reference (TYPE) SSPICSPRST Schrittinstanz-Daten 20021017
2 Returning RO_STEP Value transfer Object reference (TYPE REF TO) CL_SPI_STEP_INST Prozessschrittinstanz 20021017
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021121
2 CX_SPI_STEP PMI: Schrittausnahme 20021121
3 CX_SPI_STEP_INST Schrittinstanz-Ausnahme 20021121

Method MAKE_STEP_CHAIN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_STEPS Call by reference Type reference (TYPE) TSPISTEPI 20030411
# Exception Resumable Description Created on
1 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20030411
2 CX_SPI_TRANS PMI: Übergang-Ausnahme 20030411
3 CX_SPI_TRANS_INST Übergansinstanz-Ausnahme 20030411

Method MAKE_STEP_TREE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_STEP Value transfer Object reference (TYPE REF TO) CL_SPI_STEP_INST 20030411
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20030411
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20030411

Method MAKE_TRANSITION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_SOURCE Call by reference Object reference (TYPE REF TO) CL_SPI_STEP_INST Prozessschrittinstanz 20021018
2 Importing IO_TARGET Call by reference Object reference (TYPE REF TO) CL_SPI_STEP_INST Prozessschrittinstanz 20021018
3 Importing IT_TRANS Call by reference Type reference (TYPE) TSPIPSTD Tabelle mit Übergängen 20030411
4 Returning RO_TRANS Value transfer Object reference (TYPE REF TO) CL_SPI_TRANSITION_INST Instanz eines Prozessschrittübergangs 20021018
# Exception Resumable Description Created on
1 CX_SPI_TRANS PMI: Übergang-Ausnahme 20030411
2 CX_SPI_TRANS_INST Übergansinstanz-Ausnahme 20021121

Method REFRESH Signature

Method REFRESH on class CL_SPI_PROCESS_INST has no parameter.
# Exception Resumable Description Created on
1 CX_SPI_AUTH Ausnahme aufgrund fehlender Berechtigung 20021120
2 CX_SPI_PROC_INST PMI: Prozessinstanz-Ausnahme 20021121

Method STEPS_DB_SELECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_STEPS Call by reference Type reference (TYPE) PROC_STEP_TABLE 20021016

Method STEPS_DB_SELECT on class CL_SPI_PROCESS_INST has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 630