SAP ABAP Class CL_SPI_AGENT_GENERAL (Global PMI Tracking Agent)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
⤷
SPI7 (Package) Local: Agents
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SPI_AGENT | Abstract Class for PMIT Agents | 20030225 |
Properties
| Class | CL_SPI_AGENT_GENERAL | |
| Short Description | Global PMI Tracking Agent | |
| Super Class | CL_SPI_AGENT | Abstract Class for PMIT Agents |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SPI7 | Local: Agents |
| Created | 20030225 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_SPI_AGENT_GENERAL has no interface implemented.
Friends
Class CL_SPI_AGENT_GENERAL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Protected | Type reference (TYPE) | SPIAGNTID | 'yxPNsI9FXac7XmQTlliFp0' | SPI Global: Agent ID | 20030225 | ||
| 2 | Instance attribute | Protected | Type reference (TYPE) | SPIATTVAL | Application ID | 20030225 | |||
| 3 | Instance attribute | Protected | Type reference (TYPE) | TSPINV | Tracking Data | 20030225 | |||
| 4 | Instance attribute | Protected | Type reference (TYPE) | SPIAGNTID | SPI Global: Agent ID | 20091022 | |||
| 5 | Instance attribute | Protected | Type reference (TYPE) | SPICMPFIN | GC_STATE_NOT_FINISHED | Indicator for end step | 20100304 | ||
| 6 | Instance attribute | Protected | Type reference (TYPE) | SPIERRST | GC_STATUS_OKAY | SPI: Error Status for Process | 20100304 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | Constructor | 20030225 | |
| 2 | Instance method | Public | Method | Checks whether the agent is active | 20091028 | |
| 3 | Instance method | Public | Method | Sets an external agent ID | 20091022 | |
| 4 | Instance method | Public | Method | Sets indicator as end step | 20100304 | |
| 5 | Instance method | Public | Method | Sets the status (red, yellow, green) | 20100304 | |
| 6 | Instance method | Public | Method | Sets single tracking data item | 20030225 | |
| 7 | Instance method | Public | Method | Sets all track data simultaneously | 20091022 |
Events
Class CL_SPI_AGENT_GENERAL has no event.
Types
Class CL_SPI_AGENT_GENERAL has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_APPLICATION_ID | Call by reference | Type reference (TYPE) | SPIATTVAL | Kennung der rufenden Applikation (Paketname) | 20030225 |
Method CONSTRUCTOR on class CL_SPI_AGENT_GENERAL has no exception.
Method IS_AGENT_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_ACTIVE | Value transfer | Type reference (TYPE) | SPIBOOL | SPI Global: Boolscher Wert | 20091028 |
Method IS_AGENT_ACTIVE on class CL_SPI_AGENT_GENERAL has no exception.
Method SET_AGENT_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_AGENT_ID | Call by reference | Type reference (TYPE) | SPIAGNTID | SPI Global: Agenten-ID | 20091022 |
Method SET_AGENT_ID on class CL_SPI_AGENT_GENERAL has no exception.
Method SET_FINISHED_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_FINISHED_STATE | Call by reference | Type reference (TYPE) | SPICMPFIN | GC_STATE_NOT_FINISHED | Endeschritt | 20100304 |
Method SET_FINISHED_STATE on class CL_SPI_AGENT_GENERAL has no exception.
Method SET_LED_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_LED_STATUS | Call by reference | Type reference (TYPE) | SPIERRST | SPI: Fehlerstatus für Prozess | 20100304 |
Method SET_LED_STATUS on class CL_SPI_AGENT_GENERAL has no exception.
Method WRITE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_FIELDNAME | Call by reference | Type reference (TYPE) | SPIDFLDNAM | SPI: Name eines Datenfelds | 20030225 | |||
| 2 | IP_VALUE | Call by reference | Type reference (TYPE) | SPIATTVAL | SPI Global: Wert zu einem Feldnamen | 20030225 |
Method WRITE_DATA on class CL_SPI_AGENT_GENERAL has no exception.
Method WRITE_DATA_ON_BLOCK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_TRACKING_DATA | Call by reference | Type reference (TYPE) | TSPINV | SPI Global: Tabelle aus Name-Wert-Paaren | 20091022 |
Method WRITE_DATA_ON_BLOCK on class CL_SPI_AGENT_GENERAL has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 730 |