SAP ABAP Class CL_SPI_PAYLOAD_TOOL (Tool Implementation with Fixed Attribute Values)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_EX_SPI_TOOL	BAdI Interface IF_EX_SPI_TOOL	20030318
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_ATTRIBUTE	Attribute of a Process, Step, or Transfer	20020807
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_ATTRIBUTE_DEFINITION	Attribute definition of a process, step, or transition	20021028
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_ATTRIBUTE_TABLE	Attribute Interface for Table Access	20031124
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SPI_TOOL	Access to Tools for Process Attributes	20020807

Properties

Class	CL_SPI_PAYLOAD_TOOL
Short Description	Tool Implementation with Fixed Attribute Values
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SPI12	Central: Analysis Tools (Process Information Tools)
Created	20020807	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_EX_SPI_TOOL	☐	☐	BAdI Interface IF_EX_SPI_TOOL	20030318
2	IF_SPI_ATTRIBUTE	☐	☐	Attribute of a Process, Step, or Transfer	20020807
3	IF_SPI_ATTRIBUTE_DEFINITION	☐	☐	Attribute definition of a process, step, or transition	20021028
4	IF_SPI_ATTRIBUTE_TABLE	☐	☐	Attribute Interface for Table Access	20031124
5	IF_SPI_TOOL	☐	☐	Access to Tools for Process Attributes	20020807

Friends

Class CL_SPI_PAYLOAD_TOOL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_AGGR_FIRST	Constant	Public	☐	Type reference (TYPE)	CHAR2	'%F'	First Chronological Occurrence	20030711
2	C_AGGR_LAST	Constant	Public	☐	Type reference (TYPE)	CHAR2	'%L'	Last Chronological Occurrence	20030714
3	GC_NAME_DURATION	Constant	Protected	☐	Type reference (TYPE)	SPIATTNAME	'DURATION'	Name of the Attribute for the Transition Duration	20020815
4	GC_NAME_TIMESTAMP	Constant	Protected	☐	Type reference (TYPE)	SPIATTNAME	'TIMESTAMP'	Name of Attribute for the Time Stamp of the Tracking Record	20020807
5	GC_NAME_TRANSID	Constant	Protected	☐	Type reference (TYPE)	SPIATTNAME	'TRANSID'	Name of Attribute for the Transaction ID	20020807
6	GC_NAME_USER	Constant	Protected	☐	Type reference (TYPE)	SPIATTNAME	'USER'	Name of Attribute for the System User	20020807
7	GO_PROCESS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SPI_CU_PROCESS		Process Data from Customizing	20020918
8	GO_STEP	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SPI_CU_STEP		Step Object from Customizing	20020807
9	GO_STEP_INST	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SPI_STEP_INST		Process Step Instance	20020903
10	GP_ID	Instance attribute	Protected	☐	Type reference (TYPE)	SPIATTNAME	'CL_SPI_PROC_OVERVIEW'	Attribute ID	20020807
11	GP_TOOL_ID	Instance attribute	Protected	☐	Type reference (TYPE)	SPITOOLID		ID of ALE Tools	20020807
12	GS_HEADER_VALUES	Instance attribute	Protected	☐	Type reference (TYPE)	TSPIPRTRHD		Tracking Record Header Data for Instances	20020807
13	GT_PAYLOAD_VALUES	Instance attribute	Protected	☐	Type reference (TYPE)	TSPIPRTRPL		Payload Data for a Step and Instances	20020807

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_AGGREGATION_ATTRIBUTE_NAME	Static method	Public	Method	Returns Attribute Name Using Payload Aggregation	20030711
2	GET_HEADER_DESCRIPTION	Instance method	Protected	Method	Returns a Tracking Record Header Value from Buffer or DB	20020807
3	GET_HEADER_VALUE	Instance method	Protected	Method	Returns a Tracking Record Header Value from Buffer or DB	20020807
4	GET_PAYLOAD_ATTRIBUTE_NAME	Static method	Public	Method	Returns Attribute Name for a Payload Attribute	20030711
5	GET_PAYLOAD_DESCRIPTION	Instance method	Protected	Method	Returns a Tracking Record Header Value from Buffer or DB	20020807
6	GET_PAYLOAD_VALUE	Instance method	Protected	Method	Returns a Payload Value from Buffer or DB	20020807
7	XET_PAYLOAD_VALUE	Instance method	Protected	Method	Returns a Payload Value from Buffer or DB	20030402

Events

Class CL_SPI_PAYLOAD_TOOL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	SSPIPRTRHD	Protected	See coding		Process GUID and Tracking Record Header Data	20020807
2	SSPIPRTRPL	Protected	See coding		Process GUID and Payload Data	20020807
3	TSPIPRTRHD	Protected	See coding		Table of Process GUID and Tracking Record Header Data	20020807
4	TSPIPRTRPL	Protected	See coding		Table of Process GUID and Payload Data	20020807

Method Signatures

Method GET_AGGREGATION_ATTRIBUTE_NAME 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)	CHAR2	C_AGGR_FIRST	Aggregationsart	20030711
2	Importing	IP_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	SPIDFLDNAM		Feldname	20030711
3	Returning	RP_ATTRIBUTE_NAME	Value transfer	☐	Type reference (TYPE)	SPIATTNAME		Attributname	20030711

Method GET_AGGREGATION_ATTRIBUTE_NAME on class CL_SPI_PAYLOAD_TOOL has no exception.

Method GET_HEADER_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_VAL	Value transfer	☐	Type reference (TYPE)	CHAR128		Payloadattributwert	20020807

Method GET_HEADER_DESCRIPTION on class CL_SPI_PAYLOAD_TOOL has no exception.

Method GET_HEADER_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STEP	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_STEP_INST		Prozessinstanz	20020903
2	Returning	RP_VAL	Value transfer	☐	Type reference (TYPE)	STRING		Payloadattributwert	20020807

Method GET_HEADER_VALUE on class CL_SPI_PAYLOAD_TOOL has no exception.

Method GET_PAYLOAD_ATTRIBUTE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	SPIDFLDNAM		Feldname	20030711
2	Returning	RP_ATTRIBUTE_NAME	Value transfer	☐	Type reference (TYPE)	SPIATTNAME		Attributname	20030711

Method GET_PAYLOAD_ATTRIBUTE_NAME on class CL_SPI_PAYLOAD_TOOL has no exception.

Method GET_PAYLOAD_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_VAL	Value transfer	☐	Type reference (TYPE)	CHAR128		Payloadattributwert	20020807

Method GET_PAYLOAD_DESCRIPTION on class CL_SPI_PAYLOAD_TOOL has no exception.

Method GET_PAYLOAD_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STEP	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_STEP_INST		Prozessschrittinstanz	20020903
2	Returning	RP_VAL	Value transfer	☐	Type reference (TYPE)	STRING		Payloadattributwert	20020807

Method GET_PAYLOAD_VALUE on class CL_SPI_PAYLOAD_TOOL has no exception.

Method XET_PAYLOAD_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STEP	Call by reference	☐	Object reference (TYPE REF TO)	CL_SPI_STEP_INST		Prozessschrittinstanz	20030402
2	Returning	RP_VAL	Value transfer	☐	Type reference (TYPE)	STRING		Payloadattributwert	20030402

Method XET_PAYLOAD_VALUE on class CL_SPI_PAYLOAD_TOOL has no exception.

History

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