SAP ABAP Class CL_FM_SPLIT_TRACE (Trace functions for Rule-Based Account Distributions)
Hierarchy
☛
EA-PS (Software Component) SAP Enterprise Extension Public Services
⤷
PSM-FM (Application Component) Funds Management
⤷
FM_SPLIT_E (Package) Automatic FM account assignment splitting tool
EA-PS (Software Component) SAP Enterprise Extension Public Services⤷
PSM-FM (Application Component) Funds Management⤷
FM_SPLIT_E (Package) Automatic FM account assignment splitting toolProperties
| Class | CL_FM_SPLIT_TRACE | |
| Short Description | Trace functions for Rule-Based Account Distributions | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | FMSPLIT | |
| Program status | P | SAP Standard Production Program |
| Category | 0 | |
| Package | FM_SPLIT_E | Automatic FM account assignment splitting tool |
| Created | 20041130 | SAP |
| Last change | 20050411 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_FM_SPLIT_TRACE has no forward declaration.
Interfaces
Class CL_FM_SPLIT_TRACE has no interface implemented.
Friends
Class CL_FM_SPLIT_TRACE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CON_BUTTON_TYPE_BUTTON |
Constant | Private | Type reference (TYPE) | INT4 | 0 | Toolbar button type: normal button | 20041130 | |
| 2 | CON_BUTTON_TYPE_SEPARATOR |
Constant | Private | Type reference (TYPE) | INT4 | 3 | Toolbar button type: separator bar | 20041130 | |
| 3 | CON_ERR_MSG |
Constant | Private | Type reference (TYPE) | SYMSGTY | 'E' | Error message | 20041130 | |
| 4 | CON_FC_ABADR_TRACE |
Constant | Private | Type reference (TYPE) | FCODE | 'ABADR_TRACE' | Function code to show derivation trace | 20041130 | |
| 5 | CON_FC_DISPLAY_RULE |
Constant | Private | Type reference (TYPE) | FCODE | 'DISPLAY_RULE' | Function code to display a rule | 20041130 | |
| 6 | CON_FC_SHOW_MESSAGES |
Constant | Private | Type reference (TYPE) | FCODE | 'SHOW_MESSAGES' | Function code: show message log | 20041202 | |
| 7 | CON_ICON_DISPLAY |
Constant | Private | Type reference (TYPE) | ICON_L2 | '@10@' | Display icon | 20041202 | |
| 8 | CON_ICON_PROTOCOL |
Constant | Private | Type reference (TYPE) | ICON_L2 | '@DH@' | Protocol icon | 20041202 | |
| 9 | CON_INFO_MSG |
Constant | Private | Type reference (TYPE) | SYMSGTY | 'I' | Info message | 20041130 | |
| 10 | CON_OFF |
Constant | Private | Type reference (TYPE) | BOOLE_D | ' ' | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20041130 | |
| 11 | CON_ON |
Constant | Private | Type reference (TYPE) | BOOLE_D | 'X' | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20041130 | |
| 12 | CON_PID_TRACE_FLAG |
Constant | Private | Type reference (TYPE) | MEMORYID | 'FM_SPLIT_TRACE' | PID value for overall trace flag | 20041130 | |
| 13 | CON_SRTFD_PREFIX |
Constant | Private | Type reference (TYPE) | CHAR12 | 'FMSP_TRACE_' | 1st part of key for saving to INDX | 20041130 | |
| 14 | CON_STEP_TYPE_DERIVE |
Constant | Public | Type reference (TYPE) | CHAR1 | 'D' | Trace step type: Derive rule | 20041130 | |
| 15 | CON_STEP_TYPE_RESULT |
Constant | Private | Type reference (TYPE) | CHAR1 | 'Z' | Step type for top level of a processing session | 20041201 | |
| 16 | CON_STEP_TYPE_RULE |
Constant | Public | Type reference (TYPE) | CHAR1 | 'R' | Trace step type: Process rule | 20041130 | |
| 17 | CON_STEP_TYPE_SPLIT |
Constant | Public | Type reference (TYPE) | CHAR1 | 'S' | Trace step type: Process split | 20041130 | |
| 18 | CON_STEP_TYPE_TOP |
Constant | Private | Type reference (TYPE) | CHAR1 | 'T' | Step type for top level of a processing session | 20041201 | |
| 19 | CON_WARN_MSG |
Constant | Private | Type reference (TYPE) | SYMSGTY | 'W' | Warning message | 20041130 | |
| 20 | GO_TRACE_DIALOGBOX |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_GUI_DIALOGBOX_CONTAINER | Dialog box for displaying trace | 20041130 | ||
| 21 | GO_TRACE_TOOLBAR |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_GUI_TOOLBAR | Toolbar Control | 20041130 | ||
| 22 | GO_TRACE_TREE |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_GUI_ALV_TREE | ALV Tree Control | 20041130 | ||
| 23 | GT_TRACE_DATA |
Static Attribute | Private | Type reference (TYPE) | TP_T_TRACE_DATA | All trace data from current session | 20041130 | ||
| 24 | GT_TRACE_FLAGS |
Static Attribute | Private | Type reference (TYPE) | TP_T_TRACE_FLAG | Table of rule-dependent trace flags | 20041130 | ||
| 25 | GT_TREE_POINTER |
Static Attribute | Private | Type reference (TYPE) | FMSP_T_TRACE_STEP | Copy of table used by tree control | 20041201 | ||
| 26 | G_BUFFER_VALID |
Static Attribute | Private | Type reference (TYPE) | BOOLE_D | Indicate if INDX data buffer is valid | 20041130 | ||
| 27 | G_IMPORTED_FROM_DB |
Static Attribute | Private | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20041201 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLEAR_ALL_TRACE_FLAGS |
Static method | Public | Method | Turn off overall trace flag and rule-dependent trace flags | 20041130 |
| 2 | GET_TRACE_FLAG |
Static method | Public | Method | Get overall trace flag or an individual rule trace flag | 20041130 |
| 3 | IMPORT_FROM_DB |
Static method | Private | Method | Import trace data from INDX database | 20041201 |
| 4 | LOAD_TRACE_FLAGS_FROM_DB |
Static method | Private | Method | 20041130 | |
| 5 | LOG_DISPLAY |
Static method | Public | Method | Display application log | 20041130 |
| 6 | ON_TRACE_CLOSE |
Static method | Private | Event handling method | On trace dialogbox close | 20041130 |
| 7 | ON_TRACE_FUNCTION |
Static method | Private | Event handling method | Handle user functions during trace display | 20041130 |
| 8 | SAVE_TRACE_TO_DB |
Static method | Public | Method | Save trace and result data to INDX and TABADRX | 20041201 |
| 9 | SET_TRACE_FLAGS |
Static method | Public | Method | Set an individual rule trace flag or overall controller flag | 20041130 |
| 10 | STORE_FOR_DISPLAY |
Static method | Public | Method | Display the results of the splitting process to the user | 20041202 |
| 11 | TRACE_DISPLAY |
Static method | Public | Method | Method to display trace results | 20041130 |
| 12 | TRACE_FIELDCAT_LOAD |
Static method | Private | Method | Set field catalog for display of results | 20041130 |
| 13 | TRACE_TREE_EVENTS_REGISTER |
Static method | Private | Method | Register events to handle in ALV tree for trace display | 20041130 |
| 14 | TRACE_TREE_HIERARCHY_LOAD |
Static method | Private | Method | 20041130 |
Events
Class CL_FM_SPLIT_TRACE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TP_TRACE_DATA | Private | See coding | 20041201 | BEGIN OF tp_trace_data,
trace_key TYPE text60,
trigger TYPE fmsplit_derive,
results TYPE fmsplit_results,
t_trace TYPE fmsp_t_trace_step,
t_fields_to_display TYPE fmsp_t_field_profile_fields,
t_msg TYPE bal_t_msg,
END OF tp_trace_data
|
||
| 2 | TP_TRACE_FLAG | Private | See coding | Trace flag settings per rule and for controller | 20041201 | BEGIN OF tp_trace_flag,
split_rule TYPE fmsp_rule_id, " Blank = Controller trace
trace_flag TYPE fmsp_trace_flag,
END OF tp_trace_flag
|
|
| 3 | TP_TRACE_NODE | Private | See coding | 20041202 | BEGIN OF tp_trace_node,
step_nbr TYPE int4,
key TYPE lvc_nkey,
END OF tp_trace_node
|
||
| 4 | TP_T_TRACE_DATA | Private | See coding | 20041201 | tp_t_trace_data TYPE STANDARD TABLE OF tp_trace_data WITH KEY trace_key
|
||
| 5 | TP_T_TRACE_FLAG | Private | See coding | Trace flag settings per rule and for controller | 20041201 | tp_t_trace_flag TYPE STANDARD TABLE OF tp_trace_flag
|
|
| 6 | TP_T_TRACE_NODE | Private | See coding | 20041202 | tp_t_trace_node TYPE STANDARD TABLE OF tp_trace_node WITH KEY step_nbr
|
Method Signatures
Method CLEAR_ALL_TRACE_FLAGS Signature
Method CLEAR_ALL_TRACE_FLAGS on class CL_FM_SPLIT_TRACE has no parameter.
Method CLEAR_ALL_TRACE_FLAGS on class CL_FM_SPLIT_TRACE has no exception.
Method GET_TRACE_FLAG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
E_TRACE_FLAG | Call by reference | Type reference (TYPE) | FMSP_TRACE_FLAG | The requested trace flag value | 20041130 | ||
| 2 |  Importing |
I_CONTROLLER_TRACE | Call by reference | Type reference (TYPE) | BOOLE_D | Indicates you want the overall trace flag | 20041130 | ||
| 3 | Importing |
I_SPLIT_RULE | Call by reference | Type reference (TYPE) | FMSP_RULE_ID | Identifier for rule whose trace flag you want | 20041130 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  INVALID_PARAMETERS |
Cannot request both individual and overall in one call | 20041130 |
Method IMPORT_FROM_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_HEADER | Call by reference | Type reference (TYPE) | FMSP_TRACE_HEADER | Header data about an account assignment trace | 20041202 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | LOAD_FAILED |
Load from database failed | 20041202 |
Method LOAD_TRACE_FLAGS_FROM_DB Signature
Method LOAD_TRACE_FLAGS_FROM_DB on class CL_FM_SPLIT_TRACE has no parameter.
Method LOAD_TRACE_FLAGS_FROM_DB on class CL_FM_SPLIT_TRACE has no exception.
Method LOG_DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_MESSAGE | Call by reference | Type reference (TYPE) | BAL_T_MSG | Application Log: Table with Messages | 20041202 | ||
| 2 | Importing |
I_LOG_HANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | Application Log: Log handle | 20041130 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOTHING_TO_DISPLAY |
No messages to display | 20041202 |
Method ON_TRACE_CLOSE Signature
Method ON_TRACE_CLOSE on class CL_FM_SPLIT_TRACE has no parameter.
Method ON_TRACE_CLOSE on class CL_FM_SPLIT_TRACE has no exception.
Method ON_TRACE_FUNCTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
FCODE | Value transfer | Attribute reference (LIKE) | 20041130 |
Method ON_TRACE_FUNCTION on class CL_FM_SPLIT_TRACE has no exception.
Method SAVE_TRACE_TO_DB Signature
Method SAVE_TRACE_TO_DB on class CL_FM_SPLIT_TRACE has no parameter.
Method SAVE_TRACE_TO_DB on class CL_FM_SPLIT_TRACE has no exception.
Method SET_TRACE_FLAGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CONTROLLER_TRACE | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20041130 | ||
| 2 | Importing |
I_RULE_TRACE | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20041130 | ||
| 3 | Importing |
I_SPLIT_RULE | Call by reference | Type reference (TYPE) | FMSP_RULE_ID | Identifier for FM account assignment splitting rule | 20041130 |
Method SET_TRACE_FLAGS on class CL_FM_SPLIT_TRACE has no exception.
Method STORE_FOR_DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_RESULTS | Call by reference | Type reference (TYPE) | FMSPLIT_RESULTS | Result data from processing an FM assignment split in COBL | 20041202 | ||
| 2 | Importing |
IS_TRIGGER | Call by reference | Type reference (TYPE) | FMSPLIT_DERIVE | Derivation Structure for FM account assignment splitting | 20041202 | ||
| 3 | Importing |
IT_FIELDS_TO_DISPLAY | Call by reference | Type reference (TYPE) | FMSP_T_FIELD_PROFILE_FIELDS | Fields in a field profile for FM account assignment split | 20041202 | ||
| 4 | Importing |
IT_TRACE | Call by reference | Type reference (TYPE) | FMSP_T_TRACE_STEP | Table of trace data for account assignment splitting | 20041202 | ||
| 5 | Importing |
I_FLG_SAVE | Call by reference | Type reference (TYPE) | BOOLE_D | Flag: store results for later display | 20041202 | ||
| 6 | Importing |
I_LOG_HANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | Application Log: Log handle | 20041202 | ||
| 7 | Importing |
I_TRACE_KEY | Call by reference | Type reference (TYPE) | TEXT60 | Ident string used to identify trace data | 20041202 | ||
| 8 | Importing |
I_WITH_TRACE_DETAILS | Call by reference | Type reference (TYPE) | BOOLE_D | ' ' | Include trace details | 20041202 |
Method STORE_FOR_DISPLAY on class CL_FM_SPLIT_TRACE has no exception.
Method TRACE_DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_HEADER | Call by reference | Type reference (TYPE) | FMSP_TRACE_HEADER | Header data about an account assignment trace | 20041202 | ||
| 2 | Importing |
I_GUI_CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Abstract Container for GUI Controls | 20041202 | ||
| 3 | Importing |
I_LOAD_FROM_DB | Call by reference | Type reference (TYPE) | BOOLE_D | ' ' | Load trace data from INDX, TABADRX | 20041201 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | LOAD_FAILED |
Unable to load trace data to display | 20041202 |
Method TRACE_FIELDCAT_LOAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RT_FIELDCATALOG | Value transfer | Type reference (TYPE) | LVC_T_FCAT | Field Catalog for List Viewer Control | 20041130 |
Method TRACE_FIELDCAT_LOAD on class CL_FM_SPLIT_TRACE has no exception.
Method TRACE_TREE_EVENTS_REGISTER Signature
Method TRACE_TREE_EVENTS_REGISTER on class CL_FM_SPLIT_TRACE has no parameter.
Method TRACE_TREE_EVENTS_REGISTER on class CL_FM_SPLIT_TRACE has no exception.
Method TRACE_TREE_HIERARCHY_LOAD Signature
Method TRACE_TREE_HIERARCHY_LOAD on class CL_FM_SPLIT_TRACE has no parameter.
Method TRACE_TREE_HIERARCHY_LOAD on class CL_FM_SPLIT_TRACE has no exception.
History
| Last changed by/on | SAP | 20050411 |
| SAP Release Created in | 600 |
