SAP ABAP Class /SRMERP/CL_WF_PROTOCOL (Manages the recording and reporting of process activities)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
MM-PUR-SSP (Application Component) Self-Service Procurement
⤷
/SRMERP/WF_CORE (Package) Workflow Engine Core
SAP_APPL (Software Component) Logistics and Accounting⤷
MM-PUR-SSP (Application Component) Self-Service Procurement⤷
/SRMERP/WF_CORE (Package) Workflow Engine CoreProperties
| Class | /SRMERP/CL_WF_PROTOCOL | |
| Short Description | Manages the recording and reporting of process activities | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /SRMERP/WF_CORE | Workflow Engine Core |
| Created | 20100517 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /SRMERP/CL_WF_PROTOCOL has no forward declaration.
Interfaces
Class /SRMERP/CL_WF_PROTOCOL has no interface implemented.
Friends
Class /SRMERP/CL_WF_PROTOCOL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_RECORD_LVL_BEGIN |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'LVL_BEGIN' | WF Protocol record: level begin | 20100517 | |
| 2 | GC_RECORD_PRC_BEGIN |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'PRC_BEGIN' | WF protocol record: process started | 20100517 | |
| 3 | GC_RECORD_PRC_CANCEL |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'PRC_CANCEL' | WF Protocol record: process recalled | 20100517 | |
| 4 | GC_RECORD_PRC_DELETED |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'PRC_DELETED' | WF Protocol record: process recalled | 20100517 | |
| 5 | GC_RECORD_PRC_END |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'PRC_END' | WF Protocol record: process ended | 20100517 | |
| 6 | GC_RECORD_PRC_INIT |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'PRC_INIT' | WF Protocol record: process initialized | 20100517 | |
| 7 | GC_RECORD_PRC_INTERRUPT |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'PRC_INTER' | Denotes the type of a workflow protocol record | 20100517 | |
| 8 | GC_RECORD_PRC_RECALL |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'PRC_RECALL' | Denotes the type of a workflow protocol record | 20100517 | |
| 9 | GC_RECORD_STP_ADJUSTMENT |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'STP_ADJUST' | WF Protocol record: adjustment step | 20100517 | |
| 10 | GC_RECORD_STP_COMPLETION |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'STP_COMPL' | WF Protocol record: completion step | 20100517 | |
| 11 | GC_RECORD_STP_DECISION |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'STP_DECIS' | WF Protocol record: decision step | 20100517 | |
| 12 | GC_RECORD_STP_REVIEW |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'STP_REVIEW' | WF Protocol record: review step | 20100517 | |
| 13 | GC_RECORD_STP_REVISE |
Constant | Public | Type reference (TYPE) | /SRMERP/WF_RECORD_TYPE | 'STP_REVISE' | Denotes the type of a workflow protocol record | 20100517 | |
| 14 | MO_PROTOCOL |
Static Attribute | Private | Object reference (TYPE REF TO) | /SRMERP/CL_WF_PROTOCOL | Manages the recording and reporting of process activities | 20100517 | ||
| 15 | MV_LOG_COUNT |
Instance attribute | Private | Type reference (TYPE) | NUMC4 | 0 | Count parameters | 20100517 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | 20100517 | |
| 2 | GET_CURRENT_LOG_COUNT |
Instance method | Private | Method | Current log count | 20100517 |
| 3 | GET_NEXT_LOG_COUNT |
Instance method | Private | Method | Next available log count | 20100517 |
| 4 | INCREASE_LOG_COUNT |
Instance method | Private | Method | Increase the log count by one | 20100517 |
| 5 | RECORD_ADJUSTMENT_STEP |
Static method | Public | Method | Record the acceptance of item rejection or discussion | 20100517 |
| 6 | RECORD_COMPLETION_STEP |
Static method | Public | Method | Records the execution of a completion step | 20100517 |
| 7 | RECORD_DECISION_STEP |
Static method | Public | Method | Records the execution of an approval step | 20100517 |
| 8 | RECORD_DOCUMENT_RECALL |
Static method | Public | Method | Records the request for a document recall (by the requester) | 20100517 |
| 9 | RECORD_LEVEL_BEGIN |
Static method | Public | Method | Records the start of a process. | 20100517 |
| 10 | RECORD_PROCESS_BEGIN |
Static method | Public | Method | Records the start of a process. | 20100517 |
| 11 | RECORD_PROCESS_CANCELATION |
Static method | Public | Method | Records the cancelation of a process | 20100517 |
| 12 | RECORD_PROCESS_DELETION |
Static method | Public | Method | Records the deletion of a process | 20100517 |
| 13 | RECORD_PROCESS_END |
Static method | Public | Method | Records the end of a process execution | 20100517 |
| 14 | RECORD_PROCESS_INITIATION |
Static method | Public | Method | Records the initiation of a process. | 20100517 |
| 15 | RECORD_PROCESS_INTERRUPTION |
Static method | Public | Method | Records the successfull process interruption | 20100517 |
| 16 | RECORD_REVIEW_STEP |
Static method | Public | Method | Records the execution of a review | 20100517 |
| 17 | RECORD_REVISE_STEP |
Static method | Public | Method | Records the execution of a revision step | 20100517 |
| 18 | RESET_LOG_COUNT |
Instance method | Private | Method | Reset the log count to zero. | 20100517 |
Events
Class /SRMERP/CL_WF_PROTOCOL has no event.
Types
Class /SRMERP/CL_WF_PROTOCOL has no local type.
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class /SRMERP/CL_WF_PROTOCOL has no parameter.
Method CLASS_CONSTRUCTOR on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method GET_CURRENT_LOG_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RV_LOG_COUNT | Value transfer | Attribute reference (LIKE) | MV_LOG_COUNT | Count parameters | 20100517 |
Method GET_CURRENT_LOG_COUNT on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method GET_NEXT_LOG_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_LOG_COUNT | Value transfer | Attribute reference (LIKE) | MV_LOG_COUNT | Count parameters | 20100517 |
Method GET_NEXT_LOG_COUNT on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method INCREASE_LOG_COUNT Signature
Method INCREASE_LOG_COUNT on class /SRMERP/CL_WF_PROTOCOL has no parameter.
Method INCREASE_LOG_COUNT on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_ADJUSTMENT_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_WORKITEM_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_ADJUSTMENT_STEP on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_COMPLETION_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_WORKITEM_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_COMPLETION_STEP on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_DECISION_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_WORKITEM_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_DECISION_STEP on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_DOCUMENT_RECALL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_LEVEL_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_DOCUMENT_RECALL on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_LEVEL_BEGIN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_LEVEL_ID | Call by reference | Type reference (TYPE) | OS_GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | OS_GUID | Globally Unique Identifier | 20100517 |
Method RECORD_LEVEL_BEGIN on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_PROCESS_BEGIN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_PROCESS_BEGIN on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_PROCESS_CANCELATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_PROCESS_CANCELATION on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_PROCESS_DELETION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_PROCESS_DELETION on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_PROCESS_END Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_PROCESS_END on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_PROCESS_INITIATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_DOC_SUBSET_KEY | Call by reference | Type reference (TYPE) | /SRMERP/WF_DOC_SUBSET_KEY | GUID of SRM purchasing document | 20100716 | ||
| 3 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_PROCESS_INITIATION on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_PROCESS_INTERRUPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_WORKITEM_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_PROCESS_INTERRUPTION on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_REVIEW_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_WORKITEM_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_REVIEW_STEP on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RECORD_REVISE_STEP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AGENT_ID | Call by reference | Type reference (TYPE) | /SRMERP/WF_AGENT_ID | Identification (PD-Org. ID) of workflow agent | 20100517 | ||
| 2 | Importing |
IV_PROCESS_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 | ||
| 3 | Importing |
IV_WORKITEM_ID | Call by reference | Type reference (TYPE) | GUID | Globally Unique Identifier | 20100517 |
Method RECORD_REVISE_STEP on class /SRMERP/CL_WF_PROTOCOL has no exception.
Method RESET_LOG_COUNT Signature
Method RESET_LOG_COUNT on class /SRMERP/CL_WF_PROTOCOL has no parameter.
Method RESET_LOG_COUNT on class /SRMERP/CL_WF_PROTOCOL has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 606 |
