SAP ABAP Interface IF_FDT_LEAN_TRACE (FDT: Lean Trace)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
⤷
SFDT_CORE (Package) BRFplus: Core
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FDT_TRACE | FDT: Trace | 20081211 |
Properties
| Interface | IF_FDT_LEAN_TRACE | |
| Short Description | FDT: Lean Trace |
General Data
| Package | SFDT_CORE | BRFplus: Core |
| Created | 20081211 | SAP |
| Last changed | 20141121 | |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | CL_FDT_DSM | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 3 | CL_FDT_TRACE | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 4 | IF_FDT_LEAN_TRACE | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 5 | IF_FDT_TRACE | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 6 | IF_FDT_TYPES | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_FDT_TRACE_WRITE | FDT: Trace (Write Interface) | 20081215 |
Friends
Interface IF_FDT_LEAN_TRACE has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_DEFAULT_LEAN_TRACE_TABLE | Constant | Public | Type reference (TYPE) | TABNAME | GC_DEFAULT_TRACE_DB_JSTAB_H | Default Table for lean trace (Cluster) | 20130513 | |
| 2 | GC_DEFAULT_TRACE_DB_JSTAB_H | Constant | Public | Type reference (TYPE) | TABNAME | 'FDT_TRACE_0200' | Default Table JSON Header (content removed periodically) | 20130428 | |
| 3 | GC_DEFAULT_TRACE_DB_JSTAB_R | Constant | Public | Type reference (TYPE) | TABNAME | 'FDT_TRACE_0201' | Default Table JSON Records (content removed periodically) | 20130428 | |
| 4 | GC_DEFAULT_TRACE_DB_TABLE | Constant | Public | Type reference (TYPE) | TABNAME | 'FDT_TRACE_0100' | Default Trace Cluster Table (content removed periodically) | 20090303 | |
| 5 | MS_HEADER | Instance attribute | Public | Type reference (TYPE) | S_HEADER_EXT | Working structure for trace header | 20081215 | ||
| 6 | MS_RECORD | Instance attribute | Public | Type reference (TYPE) | S_RECORD | Working structure for trace record | 20081215 | ||
| 7 | MTS_RECORD | Instance attribute | Public | Type reference (TYPE) | TS_RECORD | 20090317 | |||
| 8 | MT_HEADER | Instance attribute | Public | Type reference (TYPE) | T_HEADER_EXT | Trace Headers | 20081215 | ||
| 9 | MV_EXTERNAL_ID | Instance attribute | Public | Type reference (TYPE) | EXTERNAL_ID | External ID | 20081216 | ||
| 10 | MV_MODE | Instance attribute | Public | Attribute reference (LIKE) | 20081215 | ||||
| 11 | MV_TRACE_DB_JSTAB_H | Instance attribute | Public | Attribute reference (LIKE) | 20130514 | ||||
| 12 | MV_TRACE_DB_JSTAB_R | Instance attribute | Public | Attribute reference (LIKE) | 20130514 | ||||
| 13 | MV_UUID | Instance attribute | Public | Attribute reference (LIKE) | 20081216 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Check Authorization for Lean Trace Create/Read/Delete | 20090323 | |
| 2 | Instance method | Public | Method | Clear buffered trace from memory | 20090303 | |
| 3 | Instance method | Public | Method | Delete Trace from DB | 20081215 | |
| 4 | Instance method | Public | Method | 20090303 | ||
| 5 | Instance method | Public | Method | Merge the trace of other (sub) functions | 20090209 | |
| 6 | Instance method | Public | Method | OBSOLETE - DO NOT USE | 20090209 | |
| 7 | Instance method | Public | Method | Read Trace from DB | 20081215 | |
| 8 | Instance method | Public | Method | Save Trace into DB | 20090209 | |
| 9 | Instance method | Public | Method | Set value in record | 20130505 | |
| 10 | Instance method | Public | Method | 20090303 |
Events
Interface IF_FDT_LEAN_TRACE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | EXTERNAL_ID | Public | Type reference (TYPE) | FDT_TRACE_EXTERNAL_ID | External ID of Trace | 20090303 | |
| 2 | S_HEADER | Public | See coding | Trace Header | 20081215 | BEGIN OF s_header,
trace_uuid TYPE sysuuid_c32,
trace_start TYPE timestampl,
trace_end TYPE timestampl,
trace_proc_time TYPE if_fdt_types=>timestamp, "processing timestamp of the function
trace_user TYPE syuname,
trace_fct_id TYPE sysuuid_x,
trace_ext_id TYPE fdt_trace_external_id,
trace_ref_uuid TYPE sysuuid_x, "parent trace UUID
trace_version TYPE fdt_trace_version,
trace_unversion TYPE boole_d,
trace_obj_unversioned TYPE boole_d,
END OF s_header
|
|
| 3 | S_HEADER_EXT | Public | See coding | Trace Header with Status | 20090113 | BEGIN OF s_header_ext.
INCLUDE TYPE s_header AS header.
TYPES: trace_saved TYPE abap_bool. " Trace saved already
TYPES: auth_failed TYPE abap_bool. " Authorization check failed
TYPES: END OF s_header_ext
|
|
| 4 | S_RECORD | Public | See coding | Trace Record | 20081215 | BEGIN OF s_record,
trace_uuid TYPE sysuuid_x,
seqnr TYPE x LENGTH 4,
id TYPE sysuuid_x,
parent_id TYPE sysuuid_x,
position TYPE char100,
value TYPE xstring,
value_json TYPE string,
ref TYPE REF TO data,
END OF s_record
|
|
| 5 | TR_EXTERNAL_ID | Public | See coding | Range of External ID for Trace | 20090113 | tr_external_id TYPE RANGE OF external_id
|
|
| 6 | TR_TRACE_END | Public | See coding | Range of Trace Ending Timestamp | 20090331 | tr_trace_end TYPE RANGE OF s_header-trace_end
|
|
| 7 | TR_TRACE_START | Public | See coding | Range of Trace Starting Timestamp | 20090331 | tr_trace_start TYPE RANGE OF s_header-trace_start
|
|
| 8 | TR_TRACE_UUID | Public | See coding | Range of Trace UUID | 20090113 | tr_trace_uuid TYPE RANGE OF s_header-trace_uuid
|
|
| 9 | TS_RECORD | Public | See coding | Trace Records | 20090317 | ts_record TYPE SORTED TABLE OF s_record WITH UNIQUE KEY trace_uuid seqnr
WITH NON-UNIQUE SORTED KEY skey2 COMPONENTS trace_uuid parent_id
|
|
| 10 | T_HEADER | Public | See coding | Trace Headers | 20081215 | t_header TYPE STANDARD TABLE OF s_header
|
|
| 11 | T_HEADER_EXT | Public | See coding | Trace Headers with Status | 20090113 | t_header_ext TYPE TABLE OF s_header_ext
|
Method Signatures
Method AUTHORITY_CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ACTIVITY | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ACTIVITY | Supported Activities: 1: Create, 3: Display, 4: Delete | 20090323 | |||
| 2 | IV_APPL_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | BRF+ Application ID | 20090325 | |||
| 3 | IV_EXTERNAL_ID | Call by reference | Type reference (TYPE) | IF_FDT_LEAN_TRACE=>EXTERNAL_ID | External ID of Trace | 20090323 | |||
| 4 | IV_FUNCTION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>ID | BRF+ Function ID | 20090323 | |||
| 5 | RV_PASSED | Value transfer | Type reference (TYPE) | ABAP_BOOL | Authorization Check Passed | 20090323 |
Method AUTHORITY_CHECK on Interface IF_FDT_LEAN_TRACE has no exception.
Method CLEAR_MEMORY Signature
Method CLEAR_MEMORY on Interface IF_FDT_LEAN_TRACE has no parameter.
Method CLEAR_MEMORY on Interface IF_FDT_LEAN_TRACE has no exception.
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_DELETE_FAILED | Call by reference | Type reference (TYPE) | T_HEADER | Trace CANNOT be deleted | 20091022 | |||
| 2 | ET_DELETE_OK | Call by reference | Type reference (TYPE) | T_HEADER | Trace successfully deleted or To be deleted in update task | 20091022 | |||
| 3 | ET_MESSAGE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages from application exit | 20120224 | |||
| 4 | ITR_EXTERNAL_ID | Call by reference | Type reference (TYPE) | TR_EXTERNAL_ID | Range of External ID for Trace | 20090209 | |||
| 5 | ITR_FUNCTION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TRACE=>TR_FUNCTION_ID | Range of function IDs | 20090209 | |||
| 6 | ITR_TRACE_END | Call by reference | Type reference (TYPE) | TR_TRACE_END | Range of Trace Ending Timestamp | 20090422 | |||
| 7 | ITR_TRACE_REF_UUID | Call by reference | Type reference (TYPE) | TR_TRACE_UUID | Range of Parent Trace UUID. Used to delete child traces | 20090303 | |||
| 8 | ITR_TRACE_START | Call by reference | Type reference (TYPE) | TR_TRACE_START | Range of Trace Starting Timestamp | 20090422 | |||
| 9 | ITR_TRACE_UUID | Call by reference | Type reference (TYPE) | TR_TRACE_UUID | Range of Trace UUID | 20090209 | |||
| 10 | ITR_USER | Call by reference | Type reference (TYPE) | IF_FDT_TRACE=>TR_USER | Range of users | 20090209 | |||
| 11 | IV_AUTH_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Check Authorization or not | 20090209 | ||
| 12 | IV_DELETE_INVALID | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Delete invalid traces only | 20120221 | ||
| 13 | IV_UPDATE_TASK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Delete in udpate task | 20091022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20090209 | ||
| 2 | FDT: System Failure | 20090422 |
Method GET_TRACE_DB_TABLE Signature
Method GET_TRACE_DB_TABLE on Interface IF_FDT_LEAN_TRACE has no parameter.
Method GET_TRACE_DB_TABLE on Interface IF_FDT_LEAN_TRACE has no exception.
Method MERGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_TRACE | Call by reference | Object reference (TYPE REF TO) | IF_FDT_LEAN_TRACE | FDT: Lean Trace | 20090209 | |||
| 2 | IV_AS_CHILD | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Merge IO_TRACE as a child | 20090209 | ||
| 3 | IV_PARENT_ID | Call by reference | Type reference (TYPE) | IF_FDT_LEAN_TRACE=>S_RECORD-PARENT_ID | Parent ID for IO_TRACE if it is to be merged as a child | 20090209 | |||
| 4 | IV_POSITION | Call by reference | Type reference (TYPE) | STRING | CL_FDT_TRACE=>GC_POSCODE_TARGET_FUNC | 20111129 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20090209 |
Method PARSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_TRACE_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | Trace XML Document Instance | 20090306 | |||
| 2 | ET_MESSAGE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20111228 | |||
| 3 | EV_TRACE | Call by reference | Type reference (TYPE) | STRING | Trace XML string | 20090225 | |||
| 4 | ITR_EXTERNAL_ID | Call by reference | Type reference (TYPE) | TR_EXTERNAL_ID | Range of External ID for Trace | 20090209 | |||
| 5 | ITR_FUNCTION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TRACE=>TR_FUNCTION_ID | Range of function IDs | 20090209 | |||
| 6 | ITR_TRACE_END | Call by reference | Type reference (TYPE) | TR_TRACE_END | Range of Trace Ending Timestamp | 20090422 | |||
| 7 | ITR_TRACE_START | Call by reference | Type reference (TYPE) | TR_TRACE_START | Range of Trace Starting Timestamp | 20090422 | |||
| 8 | ITR_TRACE_UUID | Call by reference | Type reference (TYPE) | TR_TRACE_UUID | Range of Trace UUID | 20090209 | |||
| 9 | ITR_USER | Call by reference | Type reference (TYPE) | IF_FDT_TRACE=>TR_USER | Range of users | 20090209 | |||
| 10 | IT_REMOTE_HEADER | Call by reference | Type reference (TYPE) | CL_FDT_DSM=>T_TRACE | Trace Headers | 20121123 | |||
| 11 | IV_AUTH_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Check Authorization or not | 20090209 | ||
| 12 | IV_DEEP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Read Sub-Traces or not | 20090209 | ||
| 13 | IV_REMOTE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20121123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20090209 | ||
| 2 | FDT: System Failure | 20090422 |
Method READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ETS_TRACE_RECORD | Call by reference | Type reference (TYPE) | TS_RECORD | Trace Records | 20090317 | |||
| 2 | ET_TRACE_HEADER | Call by reference | Type reference (TYPE) | T_HEADER | Trace Headers | 20090209 | |||
| 3 | ITR_EXTERNAL_ID | Call by reference | Type reference (TYPE) | TR_EXTERNAL_ID | Range of External ID for Trace | 20090209 | |||
| 4 | ITR_FUNCTION_ID | Call by reference | Type reference (TYPE) | IF_FDT_TRACE=>TR_FUNCTION_ID | Range of Function IDs | 20090209 | |||
| 5 | ITR_TRACE_END | Call by reference | Type reference (TYPE) | TR_TRACE_END | Range of Trace Ending Timestamp | 20090331 | |||
| 6 | ITR_TRACE_REF_UUID | Call by reference | Type reference (TYPE) | TR_TRACE_UUID | Range of Parent Trace UUID. Used to read child traces | 20090209 | |||
| 7 | ITR_TRACE_START | Call by reference | Type reference (TYPE) | TR_TRACE_START | Range of Trace Starting Timestamp | 20090331 | |||
| 8 | ITR_TRACE_UUID | Call by reference | Type reference (TYPE) | TR_TRACE_UUID | Range of Trace UUIDs | 20090209 | |||
| 9 | ITR_USER | Call by reference | Type reference (TYPE) | IF_FDT_TRACE=>TR_USER | Range of Users | 20090209 | |||
| 10 | IV_AUTH_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Check Authorization or not | 20090209 | ||
| 11 | IV_DEEP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Read Sub-Traces or not | 20090209 | ||
| 12 | IV_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20120905 | |||
| 13 | IV_MEMORY_ONLY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | ABAP_TRUE: Read from memory only but not from DB | 20090303 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20090209 | ||
| 2 | FDT: System Failure | 20090422 |
Method SAVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_SAVE_FAILED | Call by reference | Type reference (TYPE) | T_HEADER | Traces Failed in Saving | 20090319 | |||
| 2 | ET_SAVE_OK | Call by reference | Type reference (TYPE) | T_HEADER | Traces Saved Successfully | 20090319 | |||
| 3 | EV_UNVERSIONED | Call by reference | Type reference (TYPE) | ABAP_BOOL | Trace contains unversioned Object | 20111228 | |||
| 4 | IV_AUTH_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Whether authorization check shall be checked | 20090209 | ||
| 5 | IV_EXTERNAL_ID | Call by reference | Type reference (TYPE) | EXTERNAL_ID | External ID of Trace | 20090209 | |||
| 6 | IV_UPDATE_TASK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Save Trace in Update Task | 20090615 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | FDT: Invalid Input | 20090209 | ||
| 2 | FDT: System Failure | 20090422 |
Method SET_RECORD_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CS_RECORD | Call by reference | Type reference (TYPE) | IF_FDT_LEAN_TRACE=>S_RECORD | Trace Record | 20130505 | |||
| 2 | IA_ANY | Call by reference | Type reference (TYPE) | ANY | Value | 20130505 |
Method SET_RECORD_VALUE on Interface IF_FDT_LEAN_TRACE has no exception.
Method SET_TRACE_DB_TABLE Signature
Method SET_TRACE_DB_TABLE on Interface IF_FDT_LEAN_TRACE has no parameter.
Method SET_TRACE_DB_TABLE on Interface IF_FDT_LEAN_TRACE has no exception.
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 720 |