SAP ABAP Class CL_SPI_CU_METRIC (Metric Data from Customizing)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
⤷
SPI2 (Package) Central: Meta Data
⤷
⤷
Properties
| Class | CL_SPI_CU_METRIC | |
| Short Description | Metric Data from Customizing | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SPI2 | Central: Meta Data |
| Created | 20070430 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class CL_SPI_CU_METRIC has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_SPI_CU_PROCESS | 20070430 | Process Data from Customizing |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '006' | Counter with field value condition | 20080204 | ||
| 2 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '004' | Counter without condition | 20080204 | ||
| 3 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '005' | Counter with status condition | 20080204 | ||
| 4 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '001' | Field Value | 20070829 | ||
| 5 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '001' | One-Step Metric | 20070430 | ||
| 6 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '002' | Runtime | 20070904 | ||
| 7 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '003' | Status | 20070829 | ||
| 8 | Constant | Public | Type reference (TYPE) | SPIMETRICTYPE | '002' | Two-Step Metric | 20070430 | ||
| 9 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_SPI_METRIC_ADMIN | PMI Metric Administration | 20070508 | |||
| 10 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_SPI_RT_METRIC_CALC | RT Metric EXIT: Interface for metric calculation | 20100726 | |||
| 11 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_SPI_CU_PROCESS | Process Data from Customizing | 20070430 | |||
| 12 | Instance attribute | Private | Type reference (TYPE) | TSPISTPLFD | SPI: Table Payload Field in Step | 20100726 | |||
| 13 | Instance attribute | Private | Type reference (TYPE) | TSPICUSTEP | Table of Process Steps | 20070502 | |||
| 14 | Instance attribute | Public | Type reference (TYPE) | I | Counter for Current Hour | 20070510 | |||
| 15 | Instance attribute | Private | Type reference (TYPE) | SPIBOOL | spi_false | Global SPI: Boolean Value | 20070509 | ||
| 16 | Instance attribute | Private | Type reference (TYPE) | TIMESTAMPL | UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun) | 20070509 | |||
| 17 | Instance attribute | Private | Type reference (TYPE) | SPIDFLDNAM | SPI: Data Field Name | 20070502 | |||
| 18 | Instance attribute | Public | Type reference (TYPE) | SPIMETRICNAME | SPI: Metric Name | 20070430 | |||
| 19 | Instance attribute | Protected | Type reference (TYPE) | SPIMETRICTYPE | SPI: Metric Type | 20070430 | |||
| 20 | Instance attribute | Private | Type reference (TYPE) | SPIRTMFLT | Filter for RT Metric Enhancement Spot (SPI_RT_METRIC_EXIT) | 20100726 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Gets analysis options (step and process instance analysis) | 20070508 | |
| 2 | Instance method | Public | Method | Gets termination frequency for event generation in 1/h | 20070508 | |
| 3 | Instance method | Public | Method | Gets condition for event generation | 20070508 | |
| 4 | Instance method | Public | Method | Gets timeout for completino of multi-step events | 20070508 | |
| 5 | Instance method | Public | Method | Gets trigger for a reply event | 20070605 | |
| 6 | Instance method | Public | Method | Gets field for metric calculoation | 20070502 | |
| 7 | Instance method | Public | Method | Gets reference to CL_SPI_METRIC_ADMIN | 20080804 | |
| 8 | Instance method | Public | Method | Gets description for metric | 20070503 | |
| 9 | Instance method | Public | Method | 20070430 | ||
| 10 | Instance method | Public | Method | Returns reference to IF_SPI_RT_METRIC_CALC | 20100726 | |
| 11 | Instance method | Public | Method | Returns the filter value for the RT metric enhancement | 20100726 | |
| 12 | Instance method | Public | Method | Returns field vals for RT metrics (for both steps) if necc. | 20100726 | |
| 13 | Instance method | Public | Method | Gets steps from the metric definition | 20070502 | |
| 14 | Instance method | Public | Method | Increaqses the event counter for unsaved events | 20070510 | |
| 15 | Instance method | Public | Method | Check if metric is active | 20070508 | |
| 16 | Instance method | Public | Method | Checks whether maximum number of events is reached | 20070509 | |
| 17 | Instance method | Public | Method | Resets the event counter for unsaved events | 20070510 |
Events
Class CL_SPI_CU_METRIC has no event.
Types
Class CL_SPI_CU_METRIC has no local type.
Method Signatures
Method GET_ANALYZE_OPTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_RESULT | Value transfer | Type reference (TYPE) | SSPIEVANAOPT | PMI Event Analyseoptionen | 20070508 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler im Zugriff auf Administrationsdaten | 20070508 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20070508 |
Method GET_CUTOFF_FREQU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_PERIOD | Call by reference | Type reference (TYPE) | INT4 | 1 | Dauer des Betrachtungszeitraums | 20070508 | ||
| 2 | IP_UNIT | Call by reference | Type reference (TYPE) | SPITUNIT | 'H' | Zeiteinheit des Betrachtungszeitraums (D,H,M,S) | 20070508 | ||
| 3 | RP_RESULT | Value transfer | Type reference (TYPE) | SPIMAXREP | PMI maximale Wiederholungen eines Events | 20070508 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler im Zugriff auf Administrationsdaten | 20070508 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20070508 |
Method GET_EVENT_CONDITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_RANGE | Call by reference | Type reference (TYPE) | IF_SPI_METRIC_ADMIN=>TT_VALUE_RANGE | Liefert Range für Event Condition | 20070508 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler im Zugriff auf Administrationsdaten | 20070508 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20070508 |
Method GET_EVENT_TIMEOUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | I | Zeitüberschreitungslimit | 20070508 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler im Zugriff auf Administrationsdaten | 20070508 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20070508 |
Method GET_EVENT_TIME_LIMIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | I | Zeit in Sekunden | 20070605 |
Method GET_EVENT_TIME_LIMIT on class CL_SPI_CU_METRIC has no exception.
Method GET_FIELD_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | SPIDFLDNAM | SPI: Name eines Datenfelds | 20070502 |
Method GET_FIELD_NAME on class CL_SPI_CU_METRIC has no exception.
Method GET_METRIC_ADMIN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SPI_METRIC_ADMIN | Konfiguration und Administration einer PMI Metrik | 20080804 |
Method GET_METRIC_ADMIN on class CL_SPI_CU_METRIC has no exception.
Method GET_METRIC_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_LANGU | Call by reference | Type reference (TYPE) | SYLANGU | SY-LANGU | Sprachenschlüssel der aktuellen Textumgebung | 20070503 | ||
| 2 | RP_RESULT | Value transfer | Type reference (TYPE) | SPIMETRICTXT | SPI: Beschreibung der Metrik | 20070503 |
Method GET_METRIC_DESCRIPTION on class CL_SPI_CU_METRIC has no exception.
Method GET_METRIC_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | SPIMETRICTYPE | SPI: Metriktyp | 20070430 |
Method GET_METRIC_TYPE on class CL_SPI_CU_METRIC has no exception.
Method GET_RT_METRIC_EXIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SPI_RT_METRIC_CALC | RT-Metrik-EXIT: Interface zur Metrikberechnung | 20100726 |
Method GET_RT_METRIC_EXIT on class CL_SPI_CU_METRIC has no exception.
Method GET_RT_METRIC_FILTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | SPIRTMFLT | Filter für RT-Metrik-Erweiterungsspot (SPI_RT_METRIC_EXIT) | 20100726 |
Method GET_RT_METRIC_FILTER on class CL_SPI_CU_METRIC has no exception.
Method GET_RT_METRIC_FLDNAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_RESULT | Value transfer | Type reference (TYPE) | TSPISTPLFD | SPI: Tabelle Payload Field in Step | 20100726 |
Method GET_RT_METRIC_FLDNAMES on class CL_SPI_CU_METRIC has no exception.
Method GET_STEPS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_STEPS | Value transfer | Type reference (TYPE) | TSPICUSTEP | Tabelle von Prozessschritten | 20070502 |
Method GET_STEPS on class CL_SPI_CU_METRIC has no exception.
Method INC_CUTOFF_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_COUNT | Call by reference | Type reference (TYPE) | I | 1 | 20070510 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Metrik Ausnahme beim Lesen aus dem Customizing | 20070510 |
Method IS_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | SPIBOOL | SPI Global: Boolscher Wert | 20070508 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Fehler im Zugriff auf Administrationsdaten | 20070508 | ||
| 2 | Ausnahme aufgrund fehlender Berechtigung | 20070508 |
Method IS_CUTOFF_REACHED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_RESULT | Value transfer | Type reference (TYPE) | SPIBOOL | SPI Global: Boolscher Wert | 20070509 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Metrik Ausnahme beim Lesen aus dem Customizing | 20070509 |
Method RESET_CUTOFF_COUNT Signature
Method RESET_CUTOFF_COUNT on class CL_SPI_CU_METRIC has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Metrik Ausnahme beim Lesen aus dem Customizing | 20070510 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 700 |