SAP ABAP Class /IWFND/CL_MGW_LOGGER (ODC Logger for Application Log and CCMS)
Hierarchy
☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-GW-COR (Application Component) Gateway Framework
     ⤷ /IWFND/MGW_SUPPORTABILITY (Package) GW Framework - ODC - Message Container and Logging
Properties
Class /IWFND/CL_MGW_LOGGER  
Short Description ODC Logger for Application Log and CCMS    
Super Class    
Instantiability of a Class 0  Private 
Final    
General Data
Message Class /IWFND/CM_LOGGING    
Program status P  SAP Standard Production Program 
Category 0   
Package /IWFND/MGW_SUPPORTABILITY   GW Framework - ODC - Message Container and Logging 
Created 20110711   SAP 
Last change 20131127   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
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)
Interfaces
Class /IWFND/CL_MGW_LOGGER has no interface implemented.
Friends
Class /IWFND/CL_MGW_LOGGER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MO_LOGGER Static Attribute Private Object reference (TYPE REF TO) /IWFND/CL_MGW_LOGGER Logger 20110711
2 REQUESTGUID Static Attribute Public Type reference (TYPE) STRING Request GUID 20110711
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_AGENT_EXIST Instance method Public Method Checks if the Agent Exists in the Configuration 20110711
2 CLOSE_LOGGER Instance method Public Method Closes Logging of a Request Processing(write the Logs to db) 20110711
3 CONSTRUCTOR Instance method Private Constructor Constructor 20110711
4 DISPLAY_LOG_POP_UP Instance method Public Method Displays the Messages of the Log in a Pop-up 20110711
5 FINISH_BUSINESS_PROCESS Instance method Public Method Stops the Business Processing on Gateway 20110711
6 GET_LOGGER Static method Public Method Retrieve the Singleton Logger Instance 20110711
7 INIT_BUSINESS_PROCESS Instance method Public Method Initiates the Business Processing on Gateway 20110711
8 INIT_LOGGER Static method Public Method Initialize the logger 20110725
9 LOG_BAPI_RETURN Instance method Public Method Log the Messages Returned in the BAPI-Return 20110711
10 LOG_FREE_TEXT_MESSAGE Instance method Public Method Logs a Simple Free Text Message 20110711
11 LOG_MESSAGE Instance method Public Method Log Simple Message (Only for Message Container) 20110711
12 LOG_MESSAGE_STRUCTURE Instance method Public Method Log Message via Message Container Structure 20110711
13 LOG_MONITORING_INFORMATION Instance method Public Method Add Message to the CCMS Context 20110711
14 LOG_SECURITY_MESSAGE Instance method Public Method Logs a Security Message 20110711
15 LOG_STEP_COMPLETION Instance method Public Method Log the Completion of a Processing Step 20110711
16 LOG_STEP_COMPLETION_EXCEPTION Instance method Public Method Log the Completion of a Step with an Exception 20110711
17 LOG_STEP_INIT Instance method Public Method Log the Initialization of a Processing Step 20110711
18 SET_HEADER_DIRECTION Instance method Public Method Set the Header Attribute Request Direction 20110711
19 SET_HEADER_OPERATION Instance method Public Method Set the Header Attribute Operation 20110711
20 SET_LOG_OBJECT Static method Public Method Log Object & Sub Object 20110725
21 SET_REQUEST_GUID Static method Public Method Request GUID 20110725
22 SET_USER_ID Static method Public Method User ID 20110725
Events
Class /IWFND/CL_MGW_LOGGER has no event.
Types
Class /IWFND/CL_MGW_LOGGER has no local type.
Method Signatures

Method CHECK_AGENT_EXIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_AGENT_DESCRIPTION Call by reference Type reference (TYPE) /IWFND/COR_TEXT40 Description - Char 40 20110711
2 Exporting EV_AGENT_EXISTS Call by reference Type reference (TYPE) ABAP_BOOL 20110711
3 Importing IV_AGENT Call by reference Type reference (TYPE) /IWFND/SUP_IW_AGENT IW Agent or Component 20110711

Method CHECK_AGENT_EXIST on class /IWFND/CL_MGW_LOGGER has no exception.

Method CLOSE_LOGGER Signature

Method CLOSE_LOGGER on class /IWFND/CL_MGW_LOGGER has no parameter.
Method CLOSE_LOGGER on class /IWFND/CL_MGW_LOGGER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class /IWFND/CL_MGW_LOGGER has no parameter.
Method CONSTRUCTOR on class /IWFND/CL_MGW_LOGGER has no exception.

Method DISPLAY_LOG_POP_UP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_MESSAGE_FILTER Call by reference Type reference (TYPE) BAL_R_IDNO Application Log: MSGID/MSGNO Range Table 20110711

Method DISPLAY_LOG_POP_UP on class /IWFND/CL_MGW_LOGGER has no exception.

Method FINISH_BUSINESS_PROCESS Signature

Method FINISH_BUSINESS_PROCESS on class /IWFND/CL_MGW_LOGGER has no parameter.
Method FINISH_BUSINESS_PROCESS on class /IWFND/CL_MGW_LOGGER has no exception.

Method GET_LOGGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_LOGGER Value transfer Object reference (TYPE REF TO) /IWFND/CL_MGW_LOGGER Logger instance 20110711

Method GET_LOGGER on class /IWFND/CL_MGW_LOGGER has no exception.

Method INIT_BUSINESS_PROCESS Signature

Method INIT_BUSINESS_PROCESS on class /IWFND/CL_MGW_LOGGER has no parameter.
Method INIT_BUSINESS_PROCESS on class /IWFND/CL_MGW_LOGGER has no exception.

Method INIT_LOGGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OBJECT Call by reference Type reference (TYPE) BALOBJ_D Object name 20110725
2 Importing IV_OPERATION Call by reference Type reference (TYPE) CHAR10 Operation of the Request 20110725
3 Importing IV_REQUESTGUID Call by reference Type reference (TYPE) STRING Request GUID 20110725
4 Importing IV_REQUEST_DIRECTION Call by reference Type reference (TYPE) /IWFND/SUP_REQ_DIR Direction of the Request (GW2IWF, IWF2GW, BE2IWF) 20110725
5 Importing IV_SUBOBJECT Call by reference Type reference (TYPE) BALSUBOBJ Subobject 20110725
6 Importing IV_USERID Call by reference Type reference (TYPE) UNAME SY-UNAME User Name 20110725
7 Returning RO_LOGGER Value transfer Object reference (TYPE REF TO) /IWFND/CL_LOGGER Logger instance 20110725

Method INIT_LOGGER on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_BAPI_RETURN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY Entity 20110711
2 Importing IT_BAPI_MESSAGES Call by reference Type reference (TYPE) BAPIRET2_T Table of BAPIRET2 messages 20110711
3 Importing IV_AGENT Call by reference Type reference (TYPE) /IWFND/SUP_IW_AGENT IW Agent or component 20110711
4 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type 20110711
5 Importing IV_IS_EXTERNAL Call by reference Type reference (TYPE) BOOLEAN External Message flag 20110711

Method LOG_BAPI_RETURN on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_FREE_TEXT_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY Entity 20110711
2 Importing IS_MSG Call by reference Type reference (TYPE) BAL_S_MSG Application Log: Message Data 20110711
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type 20110711
4 Importing IV_MSG_TEXT Call by reference Type reference (TYPE) /IWFND/SUP_MSG_LONGTEXT IW extended message text 20110711
5 Returning RV_MSG_HANDLE Value transfer Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711

Method LOG_FREE_TEXT_MESSAGE on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY Entity 20110711
2 Importing IV_AGENT Call by reference Type reference (TYPE) /IWFND/SUP_IW_AGENT IW Agent 20110711
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type 20110711
4 Importing IV_LOG_MSG_TEXT Call by reference Type reference (TYPE) BOOLEAN Indicates that the message is from a different backend 20110711
5 Importing IV_LOG_TO_CCMS Call by reference Type reference (TYPE) /IWFND/SUP_LOG_CCMS Indicates that the message forwarded to CCMS 20110711
6 Importing IV_MSG_HANDLE Call by reference Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711
7 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYMSGID Message Class 20110711
8 Importing IV_MSG_NUMBER Call by reference Type reference (TYPE) SYMSGNO Message Number 20110711
9 Importing IV_MSG_TEXT Call by reference Type reference (TYPE) /IWFND/SUP_MSG_LONGTEXT Free text 20110711
10 Importing IV_MSG_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type 20110711
11 Importing IV_MSG_V1 Call by reference Type reference (TYPE) ANY Message Variable 20110711
12 Importing IV_MSG_V2 Call by reference Type reference (TYPE) ANY Message Variable 20110711
13 Importing IV_MSG_V3 Call by reference Type reference (TYPE) ANY Message Variable 20110711
14 Importing IV_MSG_V4 Call by reference Type reference (TYPE) ANY Message Variable 20110711
15 Importing IV_PROBLEM_CLASS Call by reference Type reference (TYPE) BAL_S_MSG-PROBCLASS Application log: Message problem class 20110711
16 Importing IV_SYSTEM_ALIAS Call by reference Type reference (TYPE) /IWFND/DEFI_SYSTEM_ALIAS System Alias 20110711
17 Returning RV_MSG_HANDLE Value transfer Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711

Method LOG_MESSAGE on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_MESSAGE_STRUCTURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY 20110801
2 Importing IS_MESSAGE_STRUCTURE Call by reference Type reference (TYPE) /IWFND/S_MECO_MESSAGE Message structure for "Message Container" 20110711
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING 20110801
4 Importing IV_LOG_MSG_TEXT Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20110711
5 Importing IV_MSG_HANDLE Call by reference Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711
6 Returning RV_MSG_HANDLE Value transfer Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711

Method LOG_MESSAGE_STRUCTURE on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_MONITORING_INFORMATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY Entity 20110711
2 Importing IV_AGENT Call by reference Type reference (TYPE) /IWFND/SUP_IW_AGENT IW Agent 20110711
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type 20110711
4 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYMSGID Message Class 20110711
5 Importing IV_MSG_NUMBER Call by reference Type reference (TYPE) SYMSGNO Message Number 20110711
6 Importing IV_MSG_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type 20110711
7 Importing IV_MSG_V1 Call by reference Type reference (TYPE) ANY Message Variable 20110711
8 Importing IV_MSG_V2 Call by reference Type reference (TYPE) ANY Message Variable 20110711
9 Importing IV_MSG_V3 Call by reference Type reference (TYPE) ANY Message Variable 20110711
10 Importing IV_MSG_V4 Call by reference Type reference (TYPE) ANY Message Variable 20110711
11 Importing IV_SYSTEM_ALIAS Call by reference Type reference (TYPE) /IWFND/DEFI_SYSTEM_ALIAS System Alias 20110711

Method LOG_MONITORING_INFORMATION on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_SECURITY_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY Entity 20110725
2 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type 20110725
3 Importing IV_EXT_KEY Call by reference Type reference (TYPE) STRING SCL extended message text 20110711
4 Importing IV_MSG_HANDLE Call by reference Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711
5 Importing IV_MSG_TEXT Call by reference Type reference (TYPE) STRING Free text 20110711
6 Returning RV_MSG_HANDLE Value transfer Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711

Method LOG_SECURITY_MESSAGE on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_STEP_COMPLETION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY Entity 20110711
2 Importing IV_AGENT Call by reference Type reference (TYPE) /IWFND/SUP_IW_AGENT IW Agent 20110711
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type 20110711
4 Importing IV_LOG_TO_CCMS Call by reference Type reference (TYPE) /IWFND/SUP_LOG_CCMS IW Flag for logging the message to CCMS 20110711
5 Importing IV_MSG_HANDLE Call by reference Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711
6 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYMSGID Message Class 20110711
7 Importing IV_MSG_NUMBER Call by reference Type reference (TYPE) SYMSGNO Message Number 20110711
8 Importing IV_MSG_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type 20110711
9 Importing IV_MSG_V1 Call by reference Type reference (TYPE) ANY Message Variable 20110711
10 Importing IV_MSG_V2 Call by reference Type reference (TYPE) ANY Message Variable 20110711
11 Importing IV_MSG_V3 Call by reference Type reference (TYPE) ANY Message Variable 20110711
12 Importing IV_MSG_V4 Call by reference Type reference (TYPE) ANY Message Variable 20110711
13 Importing IV_PROBLEM_CLASS Call by reference Type reference (TYPE) BAL_S_MSG-PROBCLASS Application log: Message problem class 20110711
14 Importing IV_SYSTEM_ALIAS Call by reference Type reference (TYPE) /IWFND/DEFI_SYSTEM_ALIAS System Alias 20110711

Method LOG_STEP_COMPLETION on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_STEP_COMPLETION_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EXCEPTION Call by reference Object reference (TYPE REF TO) /IWFND/CX_BASE IWFND Base Exception 20110711
2 Importing IO_EXCEPTION_EXTERN Call by reference Object reference (TYPE REF TO) CX_ROOT Abstract Superclass for All Global Exceptions 20110711
3 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY Entity 20110711
4 Importing IV_AGENT Call by reference Type reference (TYPE) /IWFND/SUP_IW_AGENT IW Agent 20110711
5 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity type 20110711
6 Importing IV_LOG_TO_CCMS Call by reference Type reference (TYPE) /IWFND/SUP_LOG_CCMS IW Flag for logging the message to CCMS 20110711
7 Importing IV_MSG_HANDLE Call by reference Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711
8 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYMSGID Message Class 20110711
9 Importing IV_MSG_NUMBER Call by reference Type reference (TYPE) SYMSGNO Message Number 20110711
10 Importing IV_MSG_V1 Call by reference Type reference (TYPE) ANY Message Variable 20110711
11 Importing IV_MSG_V2 Call by reference Type reference (TYPE) ANY Message Variable 20110711
12 Importing IV_MSG_V3 Call by reference Type reference (TYPE) ANY Message Variable 20110711
13 Importing IV_MSG_V4 Call by reference Type reference (TYPE) ANY Message Variable 20110711
14 Importing IV_SYSTEM_ALIAS Call by reference Type reference (TYPE) /IWFND/DEFI_SYSTEM_ALIAS System Alias 20110711

Method LOG_STEP_COMPLETION_EXCEPTION on class /IWFND/CL_MGW_LOGGER has no exception.

Method LOG_STEP_INIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ENTITY Call by reference Type reference (TYPE) ANY ID of the object whose proccessing caused the errors 20110711
2 Importing IV_AGENT Call by reference Type reference (TYPE) /IWFND/SUP_IW_AGENT IW Agent 20110711
3 Importing IV_ENTITY_TYPE Call by reference Type reference (TYPE) STRING Entity Type 20110711
4 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYMSGID Message Class 20110711
5 Importing IV_MSG_NUMBER Call by reference Type reference (TYPE) SYMSGNO Message Number 20110711
6 Importing IV_MSG_V1 Call by reference Type reference (TYPE) ANY Message Variable 20110711
7 Importing IV_MSG_V2 Call by reference Type reference (TYPE) ANY Message Variable 20110711
8 Importing IV_MSG_V3 Call by reference Type reference (TYPE) ANY Message Variable 20110711
9 Importing IV_MSG_V4 Call by reference Type reference (TYPE) ANY Message Variable 20110711
10 Importing IV_SYSTEM_ALIAS Call by reference Type reference (TYPE) /IWFND/DEFI_SYSTEM_ALIAS System Alias 20110711
11 Returning RV_MSG_HANDLE Value transfer Type reference (TYPE) BALMSGHNDL Application Log: Message handle 20110711

Method LOG_STEP_INIT on class /IWFND/CL_MGW_LOGGER has no exception.

Method SET_HEADER_DIRECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_REQUEST_DIRECTION Call by reference Type reference (TYPE) /IWFND/SUP_REQ_DIR SCL Direction of the Request (GW2IWF, IWF2GW, BE2IWF) 20110711

Method SET_HEADER_DIRECTION on class /IWFND/CL_MGW_LOGGER has no exception.

Method SET_HEADER_OPERATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OPERATION Call by reference Type reference (TYPE) CHAR10 Character Field Length = 10 20110711

Method SET_HEADER_OPERATION on class /IWFND/CL_MGW_LOGGER has no exception.

Method SET_LOG_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OBJECT Call by reference Type reference (TYPE) BALOBJ_D Application log: Object name (Application code) 20110725
2 Importing IV_SUBOBJECT Call by reference Type reference (TYPE) BALSUBOBJ Application Log: Subobject 20110725

Method SET_LOG_OBJECT on class /IWFND/CL_MGW_LOGGER has no exception.

Method SET_REQUEST_GUID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_REQUESTGUID Call by reference Type reference (TYPE) STRING 20110725

Method SET_REQUEST_GUID on class /IWFND/CL_MGW_LOGGER has no exception.

Method SET_USER_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_USERID Call by reference Type reference (TYPE) UNAME SY-UNAME User Name 20110725

Method SET_USER_ID on class /IWFND/CL_MGW_LOGGER has no exception.
History
Last changed by/on SAP  20131127 
SAP Release Created in 250