SAP ABAP Class CL_GRFN_ATF_PREPARE (Audit Trail Framework services)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC (Application Component) Governance, Risk and Compliance
⤷
GRFN_AUDIT_TRAIL (Package) Audit Trail
GRCFND_A (Software Component) GRC Foundation ABAP⤷
GRC (Application Component) Governance, Risk and Compliance⤷
GRFN_AUDIT_TRAIL (Package) Audit TrailProperties
| Class | CL_GRFN_ATF_PREPARE | |
| Short Description | Audit Trail Framework services | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | GRFN_AUDIT_TRAIL | Audit Trail |
| Created | 20100401 | SAP |
| Last change | 20141106 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_GRFN_ATF_PREPARE has no forward declaration.
Interfaces
Class CL_GRFN_ATF_PREPARE has no interface implemented.
Friends
Class CL_GRFN_ATF_PREPARE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ATF_DATA_TYPE_ELEM |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_DATA_TYPE | 'E' | Abap Data Type - Elementary Type | 20100401 | |
| 2 | ATF_DATA_TYPE_STRUCT |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_DATA_TYPE | 'S' | Abap Data Type - Structured Type | 20100401 | |
| 3 | AT_ID |
Static Attribute | Private | Type reference (TYPE) | GUID_32 | ATF ID | 20100401 | ||
| 4 | AT_TOPIC_CAPA |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_TOPIC_ID | 'CAPA' | Audit Trail for CAPA execution | 20100401 | |
| 5 | AT_TOPIC_RFCCR |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_TOPIC_ID | 'RFCCR' | Audit Trail for CR RFC | 20100401 | |
| 6 | GC_TYPE_CREATE |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | 'C' | Change type of Audit data: Create | 20100401 | |
| 7 | GC_TYPE_DELETE |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | 'D' | Change type of Audit data: Delete | 20100401 | |
| 8 | GC_TYPE_UNCHANGED |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | 'N' | Change type of Audit data: Unchanged | 20100401 | |
| 9 | GC_TYPE_UPDATE |
Static Attribute | Public | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | 'U' | Change type of Audit data: Update | 20100401 | |
| 10 | READ_INVALID_OBJECT_KEY |
Static Attribute | Public | Type reference (TYPE) | INT4 | 3 | I_OBJECT_KEY parameter in read method is empty | 20100401 | |
| 11 | READ_INVALID_TIME |
Static Attribute | Public | Type reference (TYPE) | INT4 | 2 | I_TIME_XXX parameter(S) in read method is empty | 20100401 | |
| 12 | READ_INVALID_TOPIC_ID |
Static Attribute | Public | Type reference (TYPE) | INT4 | 1 | I_TOPIC_ID parameter in read method is invalid | 20100401 | |
| 13 | READ_NO_RECORD_FOUND |
Static Attribute | Public | Type reference (TYPE) | INT4 | 4 | No audit trail data found | 20100401 | |
| 14 | WRITE_DB_ERROR |
Static Attribute | Public | Type reference (TYPE) | INT4 | 5 | Save data to database failed | 20100401 | |
| 15 | WRITE_INVALID_CHANGE_TYPE |
Static Attribute | Public | Type reference (TYPE) | INT4 | 3 | I_CHANGE_TYPE parameter in write method is invalid | 20100401 | |
| 16 | WRITE_INVALID_OBJECT_KEY |
Static Attribute | Public | Type reference (TYPE) | INT4 | 2 | I_OBJECT_KEY parameter in write method is empty | 20100401 | |
| 17 | WRITE_INVALID_TOPIC_ID |
Static Attribute | Public | Type reference (TYPE) | INT4 | 1 | I_TOPIC_ID parameter in write method is invalid | 20100401 | |
| 18 | WRITE_INVALID_VALUE |
Static Attribute | Public | Type reference (TYPE) | INT4 | 4 | I_VALUE_XXX parameter in write method is invalid | 20100401 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_CHANGE_TYPE |
Static method | Public | Method | check change type | 20100401 |
| 2 | CHECK_OBJECT |
Static method | Public | Method | check object | 20100401 |
| 3 | CHECK_OBJECT_TABLE |
Static method | Public | Method | check object | 20100409 |
| 4 | CHECK_VALUE_LEN |
Static method | Public | Method | check value lenth | 20100401 |
| 5 | DATA_QUERY |
Static method | Public | Method | Data Preparation | 20100401 |
| 6 | GET_GUID_ID |
Static method | Public | Method | GET ATF_ID | 20100401 |
| 7 | INIT_LOCAL_VARIBLE |
Static method | Public | Method | initial local variant | 20100401 |
| 8 | RETRIVE_TEXT |
Static method | Private | Method | Text Retrive | 20100406 |
| 9 | SAVE_DATA |
Static method | Public | Method | Write audit trail data Element | 20100401 |
| 10 | WRITE_AUDIT_TRAIL |
Static method | Private | Method | Write table content to Audit Trail Structure | 20100407 |
Events
Class CL_GRFN_ATF_PREPARE has no event.
Types
Class CL_GRFN_ATF_PREPARE has no local type.
Method Signatures
Method CHECK_CHANGE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
E_RETURN_CODE | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20100401 | ||
| 2 |  Importing |
I_CHANGE_TYPE | Call by reference | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | Change type of Audit data: Insert, Delete, Update | 20100401 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100407 |
Method CHECK_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_DATA_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_DATA_TYPE | Abap Data Type | 20100401 | ||
| 2 | Exporting |
EV_TYPE_NAME | Value transfer | Type reference (TYPE) | TABNAME | Table Name | 20100401 | ||
| 3 | Importing |
IR_VALUE_NEW | Call by reference | Object reference (TYPE REF TO) | DATA | 20100409 | |||
| 4 | Importing |
IR_VALUE_OLD | Call by reference | Object reference (TYPE REF TO) | DATA | 20100409 | |||
| 5 | Importing |
I_CHANGE_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | Single-Character Flag | 20100401 | ||
| 6 | Importing |
I_VALUE_NEW | Call by reference | Type reference (TYPE) | DATA | Single-Character Flag | 20100401 | ||
| 7 | Importing |
I_VALUE_OLD | Call by reference | Type reference (TYPE) | DATA | Single-Character Flag | 20100401 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100407 |
Method CHECK_OBJECT_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_CHANGE_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | Single-Character Flag | 20100409 | ||
| 2 | Exporting |
EV_DATA_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_DATA_TYPE | Abap Data Type | 20100409 | ||
| 3 | Exporting |
EV_TYPE_NAME | Value transfer | Type reference (TYPE) | TABNAME | Table Name | 20100409 | ||
| 4 | Importing |
I_VALUE_NEW | Call by reference | Type reference (TYPE) | DATA | Single-Character Flag | 20100409 | ||
| 5 | Importing |
I_VALUE_OLD | Call by reference | Type reference (TYPE) | DATA | Single-Character Flag | 20100409 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100409 |
Method CHECK_VALUE_LEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_FLAG_NEW | Value transfer | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20100401 | ||
| 2 | Exporting |
E_FLAG_OLD | Value transfer | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20100401 | ||
| 3 | Exporting |
E_VALUE_NEW | Value transfer | Type reference (TYPE) | GUID_32 | Globally Unique Identifier | 20100401 | ||
| 4 | Exporting |
E_VALUE_OLD | Value transfer | Type reference (TYPE) | GUID_32 | Globally Unique Identifier | 20100401 | ||
| 5 | Importing |
I_VALUE_NEW | Call by reference | Type reference (TYPE) | STRING | 20100401 | |||
| 6 | Importing |
I_VALUE_OLD | Call by reference | Type reference (TYPE) | STRING | 20100401 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100407 |
Method DATA_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_AUDIT_TRAIL_DETAIL | Call by reference | Type reference (TYPE) | GRFN_T_UI_ATFS | Audit Trail Data Detail | 20100401 | ||
| 2 | Exporting |
E_AUDIT_TRAIL_MAIN | Call by reference | Type reference (TYPE) | GRFN_T_UI_ATF | Audit Trail Data Main | 20100401 | ||
| 3 | Exporting |
E_RETURN_CODE | Value transfer | Type reference (TYPE) | BAPIRETURN | Return Parameter | 20100401 | ||
| 4 | Importing |
IT_USER_MAIN | Value transfer | Type reference (TYPE) | SPERS_ULST | Who make act | 20100401 | ||
| 5 | Importing |
I_ACTION | Value transfer | Type reference (TYPE) | GRFN_ATF_ACTION | Audit Trail Action | 20100401 | ||
| 6 | Importing |
I_INFOR | Value transfer | Type reference (TYPE) | GRFN_ATF_INFO | Audit Trail Info | 20100401 | ||
| 7 | Importing |
I_OBJECT_KEY | Value transfer | Type reference (TYPE) | TABKEY | Sub-object of the Object I_OBJECT_KEY | 20100401 | ||
| 8 | Importing |
I_STATUS | Value transfer | Type reference (TYPE) | GRFN_ATF_STATUS | Audit Trail Action Status | 20100401 | ||
| 9 | Importing |
I_TIME_END | Value transfer | Type reference (TYPE) | TIMESTAMPL | When the audit starts | 20100401 | ||
| 10 | Importing |
I_TIME_START | Value transfer | Type reference (TYPE) | TIMESTAMPL | When the audit starts | 20100401 | ||
| 11 | Importing |
I_TOPIC_ID | Value transfer | Type reference (TYPE) | GRFN_ATF_TOPIC_ID | Audit Trail Topic ID | 20100401 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100407 |
Method GET_GUID_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
I_ATF_ID | Value transfer | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20100401 |
Method GET_GUID_ID on class CL_GRFN_ATF_PREPARE has no exception.
Method INIT_LOCAL_VARIBLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_TIMESTAMP | Value transfer | Type reference (TYPE) | TIMESTAMPL | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20100401 | ||
| 2 | Exporting |
E_USER_ACT | Value transfer | Type reference (TYPE) | UNAME | User actully do act | 20100401 | ||
| 3 | Exporting |
E_USER_MAIN | Value transfer | Type reference (TYPE) | UNAME | User mainly do act | 20100401 | ||
| 4 | Importing |
I_TIMESTAMP | Value transfer | Type reference (TYPE) | TIMESTAMPL | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20100401 | ||
| 5 | Importing |
I_USERNAME | Value transfer | Type reference (TYPE) | UNAME | User Name | 20100401 |
Method INIT_LOCAL_VARIBLE on class CL_GRFN_ATF_PREPARE has no exception.
Method RETRIVE_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CV_VALUE | Call by reference | Type reference (TYPE) | STRING | return text | 20100408 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100407 |
Method SAVE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_VALUE_NEW | Call by reference | Object reference (TYPE REF TO) | DATA | 20100402 | |||
| 2 | Importing |
IR_VALUE_OLD | Call by reference | Object reference (TYPE REF TO) | DATA | 20100402 | |||
| 3 | Importing |
IV_SEQUENCE | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20100430 | ||
| 4 | Importing |
I_ACTION | Value transfer | Type reference (TYPE) | GRFN_ATF_ACTION | Audit Trail Action ID | 20100401 | ||
| 5 | Importing |
I_ATF_ID | Value transfer | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20100401 | ||
| 6 | Importing |
I_CHANGE_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | Change type of Audit data: Insert, Delete, Update | 20100401 | ||
| 7 | Importing |
I_DATA_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_DATA_TYPE | Abap Data Type | 20100401 | ||
| 8 | Importing |
I_INFOR | Value transfer | Type reference (TYPE) | GRFN_ATF_INFO | Audit Trail Info | 20100401 | ||
| 9 | Importing |
I_OBJECT_KEY | Value transfer | Type reference (TYPE) | TABKEY | Table Key | 20100401 | ||
| 10 | Importing |
I_STATUS | Value transfer | Type reference (TYPE) | GRFN_ATF_STATUS | Audit Trail Status | 20100401 | ||
| 11 | Importing |
I_TIMESTAMP | Value transfer | Type reference (TYPE) | TIMESTAMPL | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20100401 | ||
| 12 | Importing |
I_TOPIC_ID | Value transfer | Type reference (TYPE) | GRFN_ATF_TOPIC_ID | Audit Trail Topic ID | 20100401 | ||
| 13 | Importing |
I_TYPE_NAME | Value transfer | Type reference (TYPE) | TABNAME | Table Name | 20100401 | ||
| 14 | Importing |
I_USERNAME | Value transfer | Type reference (TYPE) | SY-UNAME | User Name | 20100401 | ||
| 15 | Importing |
I_USER_ACT | Value transfer | Type reference (TYPE) | UNAME | User Name | 20100401 | ||
| 16 | Importing |
I_USER_MAIN | Value transfer | Type reference (TYPE) | UNAME | User Name | 20100401 | ||
| 17 | Importing |
I_USER_ROLE | Value transfer | Type reference (TYPE) | GRPC_ROLE | User Role | 20100401 | ||
| 18 | Importing |
I_VALUE_NEW | Call by reference | Type reference (TYPE) | DATA | 20100401 | |||
| 19 | Importing |
I_VALUE_OLD | Call by reference | Type reference (TYPE) | DATA | 20100401 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100407 |
Method WRITE_AUDIT_TRAIL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_VALUE_NEW | Call by reference | Object reference (TYPE REF TO) | DATA | 20100407 | |||
| 2 | Importing |
IR_VALUE_OLD | Call by reference | Object reference (TYPE REF TO) | DATA | 20100407 | |||
| 3 | Importing |
I_ATF_ID | Value transfer | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20100407 | ||
| 4 | Importing |
I_CHANGE_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_CHANGE_TYPE | Change type of Audit data: Insert, Delete, Update | 20100407 | ||
| 5 | Importing |
I_DATA_TYPE | Value transfer | Type reference (TYPE) | GRFN_ATF_DATA_TYPE | Single-Character Flag | 20100407 | ||
| 6 | Importing |
I_INFOR | Value transfer | Type reference (TYPE) | GRFN_ATF_INFO | Audit Trail Info | 20100407 | ||
| 7 | Importing |
I_TYPE_NAME | Value transfer | Type reference (TYPE) | TABNAME | Table Name | 20100407 | ||
| 8 | Returning |
RT_DETAIL | Value transfer | Type reference (TYPE) | GRFN_T_API_ATFS | Audit Trail Framework Sub data repository | 20100407 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20100407 |
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 600 |
