SAP ABAP Class CL_SPI_METRIC_API (Facade Class for Accessing Metrics)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
     ⤷ SPI6 (Package) Central: API Process Information

Properties

Class	CL_SPI_METRIC_API
Short Description	Facade Class for Accessing Metrics
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SPI6	Central: API Process Information
Created	20070425	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

Class CL_SPI_METRIC_API has no interface implemented.

Friends

Class CL_SPI_METRIC_API has no friend class.

Attributes

Class CL_SPI_METRIC_API has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALC_TIME_BASE	Static method	Public	Method	Gets Basis of a 5 min. Time Interval at Time	20080204
2	CHECK_FOR_EVENT_WO_PRGUID	Static method	Private	Method	Checks if there is unconverted data in event tables	20100708
3	COUNT_METRIC_INSTANCES	Static method	Public	Method	Counts instances of a metric for a time frame	20070514
4	DELETE_METRIC_INSTANCES	Static method	Public	Method	Deletes Metric Instances	20080211
5	GET_COUNTER_OF_METRIC	Static method	Public	Method	Gets: Number of Steps for a Metric in Time Frame	20080204
6	GET_METRICS	Static method	Public	Method	Gets the metrics for a process	20070425
7	GET_METRIC_ADMIN	Static method	Public	Method	Gets the administration interface for a metric	20070425
8	GET_METRIC_BY_NAME	Static method	Public	Method	Gets reference to a metric	20070425
9	GET_METRIC_INSTANCES	Static method	Public	Method	Gets instances of a metric for a time frame	20070425
10	GET_METRIC_INSTANCES_BY_PRINST	Static method	Public	Method	Returns metric instances for a process instance	20100607
11	GET_METRIC_INSTANCES_BY_TRGUID	Static method	Public	Method	Gets metric instances for individual tracking records	20080919
12	GET_PROC_INSTANCES_WITH_EVENT	Static method	Public	Method	Returns process instances with event(s) for a time period	20100705
13	MIGRATE_EVENT_DATA	Static method	Private	Method	Convert event data for a process instance (in DB)	20100708
14	RECHECK_1STEP_TIMEOUT	Static method	Private	Method	Check one-step timeout event (TO due to ASS "too late")	20100803
15	RECHECK_2STEP_TIMEOUT	Static method	Private	Method	Check two-step timeout event (TO due to ASS "too late")	20100615

Events

Class CL_SPI_METRIC_API has no event.

Types

Class CL_SPI_METRIC_API has no local type.

Method Signatures

Method CALC_TIME_BASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Zeitpunkt	20080204
2	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	TIMESTAMPL		Untere Intervallgrenze 5Min., Basis 00:00	20080204

Method CALC_TIME_BASE on class CL_SPI_METRIC_API has no exception.

Method CHECK_FOR_EVENT_WO_PRGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCTYPE	Call by reference	☑	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20100804
2	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	SPIBOOL		SPI Global: Boolscher Wert	20100708

Method CHECK_FOR_EVENT_WO_PRGUID on class CL_SPI_METRIC_API has no exception.

Method COUNT_METRIC_INSTANCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_NO_TIMEOUTS	Call by reference	☐	Type reference (TYPE)	I		Anzahl der aufgetretenen Time Out-Events	20100623
2	Exporting	EP_OVERFLOW	Call by reference	☐	Type reference (TYPE)	SPIBOOL		spi_true = Es sind mehr Events als angegeben aufgetreten	20070514
3	Exporting	EP_RESULT	Call by reference	☐	Type reference (TYPE)	I		Anzahl der Events für diese Metrik	20070514
4	Importing	II_METRIC	Call by reference	☐	Object reference (TYPE REF TO)	IF_SPI_METRIC		PMI Metric-Interface	20070514
5	Importing	IP_EXCL_OBSOLETES	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Obsolete (TimeOut-)Events herausfiltern?	20100616
6	Importing	IP_TIME_FROM	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20070514
7	Importing	IP_TIME_TO	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20070514

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20070514
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070514

Method DELETE_METRIC_INSTANCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_METRIC_INSTANCES	Call by reference	☐	Type reference (TYPE)	TSPIIMETRI		PMI: Tabelle von Metric Instanz Referenzen (Events)	20080211

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20080211
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20080211

Method GET_COUNTER_OF_METRIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_METRIC	Call by reference	☐	Object reference (TYPE REF TO)	IF_SPI_METRIC		PMI Metric-Interface	20080204
2	Importing	IP_TIME_FROM	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20080204
3	Importing	IP_TIME_TO	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20080204
4	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	I		Anzahl der Events für diese Metrik	20080205

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20080204
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20080204

Method GET_METRICS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_INCL_RELATED	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Einschließlich abhängiger Metriken	20090909
2	Importing	IP_PROCESS_TYPE	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20070425
3	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	TSPIIMETR		PMI: Tabelle von Metric Interface Referenzen	20070425

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20070425
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070425

Method GET_METRIC_ADMIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_METRIC_NAME	Call by reference	☐	Type reference (TYPE)	SPIMETRICNAME		SPI: Metrikname	20070425
2	Importing	IP_PROCESS_TYPE	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20070425
3	Returning	RI_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_METRIC_ADMIN		PMI Metrik Administration	20070425

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20070425
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070425

Method GET_METRIC_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_METRIC_NAME	Call by reference	☐	Type reference (TYPE)	SPIMETRICNAME		SPI: Metrikname	20070430
2	Importing	IP_PROCESS_TYPE	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20070430
3	Returning	RI_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPI_METRIC		PMI Metric-Interface	20070430

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20070425
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070425

Method GET_METRIC_INSTANCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_NO_TIMEOUTS	Call by reference	☐	Type reference (TYPE)	I		Anzahl der aufgetretenen TimeOut-Events	20100623
2	Exporting	EP_OVERFLOW	Call by reference	☐	Type reference (TYPE)	SPIBOOL		spi_true = Eventhäufigkeit erreichte Abbruchbedingung	20070515
3	Exporting	ET_METRIC_INSTANCES	Call by reference	☐	Type reference (TYPE)	TSPIIMETRI		PMI: Tabelle von Metric Instanz Referenzen (Events)	20070515
4	Importing	II_METRIC	Call by reference	☐	Object reference (TYPE REF TO)	IF_SPI_METRIC		PMI Metric-Interface	20070425
5	Importing	IP_EXCL_OBSOLETES	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Obsolete (TimeOut-)Events herausfiltern?	20100616
6	Importing	IP_TIME_FROM	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20070425
7	Importing	IP_TIME_TO	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20070425

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20070425
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20070425

Method GET_METRIC_INSTANCES_BY_PRINST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROC_INST	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_PROCESS_INST		PMI: Prozessinstanz	20100607
2	Returning	RT_METRIC_INSTANCES	Value transfer	☐	Type reference (TYPE)	TSPIIMETRI		PMI: Tabelle von Metric Instanz Referenzen (Events)	20100607

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20100607
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20100607

Method GET_METRIC_INSTANCES_BY_TRGUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_PROCTYPE	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20080919
2	Importing	IT_TRGUID	Call by reference	☐	Type reference (TYPE)	TSPITRGUID		Tabelle von Tracking Record ID's	20100614
3	Returning	RT_METRIC_INSTANCES	Value transfer	☐	Type reference (TYPE)	TSPIIMETRI		PMI: Tabelle von Metric Instanz Referenzen (Events)	20080919

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20080919
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20080919

Method GET_PROC_INSTANCES_WITH_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_OVERFLOW	Call by reference	☐	Type reference (TYPE)	SPIBOOL		spi_true = Eventhäufigkeit erreichte Abbruchbedingung	20100705
2	Exporting	ET_PROCESS_INSTANCES	Call by reference	☐	Type reference (TYPE)	TSPIIFPRIN		PMI: Tabelle von Prozessinstanz-Interfaces	20100705
3	Importing	IP_EXCL_OBSOLETES	Call by reference	☐	Type reference (TYPE)	SPIBOOL	SPI_FALSE	Obsolete (TimeOut-)Events herausfiltern?	20100705
4	Importing	IP_PROCESS_TYPE	Call by reference	☐	Type reference (TYPE)	SPIPROCTP		SPI: ID eines Prozesstypen	20100705
5	Importing	IP_TIME_FROM	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Zeitrahmen der *Eventerzeugung* (UTC-Zeitst, Langform)	20100705
6	Importing	IP_TIME_TO	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		Zeitrahmen der *Eventerzeugung* (UTC-Zeitst, Langform)	20100705

#	Exception	Resumable	Description	Created on
1	CX_SPI_API	☐	PMI: API-Ausnahme	20100705
2	CX_SPI_AUTH	☐	Ausnahme aufgrund fehlender Berechtigung	20100705

Method MIGRATE_EVENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROC_INST	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_PROCESS_INST		Prozessinstanz	20100708
2	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	SPIBOOL		Umsetzung erfolgreich?	20100708

Method MIGRATE_EVENT_DATA on class CL_SPI_METRIC_API has no exception.

Method RECHECK_1STEP_TIMEOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROC_INST	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_PROCESS_INST		Prozessinstanz	20100803
2	Importing	IP_METRICNAME	Call by reference	☐	Type reference (TYPE)	SPIMETRICNAME		SPI: Metrikname	20100803
3	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	SPIBOOL		true: der Time Out ist noch gültig	20100803

Method RECHECK_1STEP_TIMEOUT on class CL_SPI_METRIC_API has no exception.

Method RECHECK_2STEP_TIMEOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PROC_INST	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_PROCESS_INST		Prozessinstanz	20100615
2	Importing	IP_METRICNAME	Call by reference	☐	Type reference (TYPE)	SPIMETRICNAME		SPI: Metrikname	20100615
3	Importing	IP_TRGUID1	Call by reference	☐	Type reference (TYPE)	SPITRGUID		SPI: GUID of a Tracking Record	20100621
4	Returning	RP_RESULT	Value transfer	☐	Type reference (TYPE)	SPIBOOL		true: der Time Out ist noch gültig	20100615

Method RECHECK_2STEP_TIMEOUT on class CL_SPI_METRIC_API has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	700