SAP ABAP Class CL_AMC_LOGGING (AMC logging)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-MID-AC (Application Component) ABAP Channels
⤷
SAMC_TOOLS (Package) AMC troubleshooting tools, e.g. logging, tracing, etc.
⤷
⤷
Properties
| Class | CL_AMC_LOGGING | |
| Short Description | AMC logging | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | SAMC_TOOLS | |
| Program status | S | System Program |
| Category | 0 | |
| Package | SAMC_TOOLS | AMC troubleshooting tools, e.g. logging, tracing, etc. |
| Created | 20120417 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_AMC_LOGGING has no interface implemented.
Friends
Class CL_AMC_LOGGING has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | I | 120 | Expiration Time in hours for log reorganisation | 20120917 | ||
| 2 | Constant | Private | Type reference (TYPE) | DBCON_NAME | 'R/3*AMCLOG' | Name of Second Database Connection | 20120418 | ||
| 3 | Static Attribute | Private | Type reference (TYPE) | I | 0 | Is taskhandler statistic active ? | 20130227 | ||
| 4 | Static Attribute | Private | Type reference (TYPE) | AMC_SESSION_EPP_ATTR | Attributes of EPP for AMC | 20130101 | |||
| 5 | Static Attribute | Private | Type reference (TYPE) | TT_AMC_LOG_4_RT | Logging Cache for AMC Runtime | 20131205 | |||
| 6 | Static Attribute | Private | Type reference (TYPE) | AMC_LOG_STATUS_INFO_TT | Name and Value for AMC Status | 20130101 | |||
| 7 | Static Attribute | Private | Type reference (TYPE) | AMC_LOG_HASHED_ITAB_4_AUTH_CHK | Hashed Table for Authority Check of AMC Logging | 20130101 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Activate admin logging | 20120917 | |
| 2 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20130227 | |
| 3 | Static method | Public | Method | Inactivate admin logging | 20120917 | |
| 4 | Static method | Public | Method | Delete from data storage | 20120917 | |
| 5 | Static method | Public | Method | Get Status information | 20120917 | |
| 6 | Static method | Public | Method | Read from data storage | 20120917 | |
| 7 | Static method | Public | Method | Read Log Admin entries | 20120917 | |
| 8 | Static method | Public | Method | Read Log Admin entries of log creater | 20120917 | |
| 9 | Static method | Public | Method | Reorganisation of log data storage | 20120917 | |
| 10 | Static method | Public | Method | Internal use only: write AMC log | 20120917 | |
| 11 | Static method | Private | Method | Authority Check | 20120505 | |
| 12 | Static method | Private | Method | Authority Check for Read own log | 20130102 | |
| 13 | Static method | Private | Method | Inactivate admin logging | 20130101 | |
| 14 | Static method | Private | Method | Fill display name for status value | 20120521 | |
| 15 | Static method | Private | Method | Get Client | 20120423 | |
| 16 | Static method | Private | Method | Get Log Activation Mode | 20120418 | |
| 17 | Static method | Private | Method | 20121005 | ||
| 18 | Static method | Private | Method | Runs the AMC-session in a system client (client independent) | 20120504 |
Events
Class CL_AMC_LOGGING has no event.
Types
Class CL_AMC_LOGGING has no local type.
Method Signatures
Method ACTIVATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Application Identifier | 20120926 | |||
| 2 | I_CHANNEL_EXTENSION_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_EXTENSION_ID | Extension to the Channel Ids | 20120926 | |||
| 3 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | Identifier of the ABAP Messaging Channel | 20120926 | |||
| 4 | I_CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | Client ID of Current User | 20120926 | |||
| 5 | I_EXP_TIME | Call by reference | Type reference (TYPE) | INT4 | 10 | Lifetime of Log-Activation in minutes | 20120926 | ||
| 6 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE | AMC role, i.e. producer or consumer | 20120926 | |||
| 7 | I_SCOPE | Call by reference | Type reference (TYPE) | AMC_CHANNEL_SCOPE | Scope of an AMC channel | 20130131 | |||
| 8 | I_USER | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120917 |
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_AMC_LOGGING has no parameter.
Method CLASS_CONSTRUCTOR on class CL_AMC_LOGGING has no exception.
Method DEACTIVATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Channel Application identifier | 20120926 | |||
| 2 | I_CHANNEL_EXTENSION_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_EXTENSION_ID | 20120926 | ||||
| 3 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | 20120926 | ||||
| 4 | I_CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | Client ID of Current User | 20120926 | |||
| 5 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE | 20120926 | ||||
| 6 | I_USER | Call by reference | Type reference (TYPE) | SYUNAME | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120917 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Channel Identifier | 20120926 | |||
| 2 | I_CHANNEL_EXTENSION_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_EXTENSION_ID | Extension to the Channel Ids | 20120926 | |||
| 3 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | Identifier of the ABAP Messaging Channel | 20120926 | |||
| 4 | I_CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | Client ID of Current User | 20120926 | |||
| 5 | I_ENTRY_COUNTER | Call by reference | Type reference (TYPE) | INT4 | Log entry counter (to get the log entries unique) | 20120926 | |||
| 6 | I_ENTRY_ID | Call by reference | Type reference (TYPE) | SYSUUID_C32 | 16 Byte UUID in 32 Characters (Hexadecimal Encoded) | 20120926 | |||
| 7 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE | AMC role, i.e. producer or consumer | 20120926 | |||
| 8 | I_STATUS | Call by reference | Type reference (TYPE) | AMC_LOG_STATUS_UI | AMC log status (successful, erroneous, etc.) | 20120926 | |||
| 9 | I_STATUS_CODE | Call by reference | Type reference (TYPE) | AMC_LOG_STATUS | AMC log status code (see CL_AMC_LOGGING=>_FILL_STATUS_INFO) | 20120926 | |||
| 10 | I_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20120926 | |||
| 11 | I_USERNAME | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20130101 |
Method GET_STATUS_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_STATUS_INFO | Call by reference | Type reference (TYPE) | AMC_LOG_STATUS_INFO_TT | Table type for structure AMC_LOG_STATUS_INFO | 20120926 |
Method GET_STATUS_INFO on class CL_AMC_LOGGING has no exception.
Method READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_AMC_LOG_LIST | Call by reference | Type reference (TYPE) | AMC_LOG_STORAGE_TT | Table type for structure AMC_LOG_STORAGE | 20120926 | |||
| 2 | I_AMC_MSG_EPP_ATTR | Call by reference | Type reference (TYPE) | AMC_MESSAGE_EPP_ATTR | Attributes of EPP for AMC | 20120926 | |||
| 3 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Channel Identifier | 20120926 | |||
| 4 | I_CHANNEL_EXTENSION_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_EXTENSION_ID | Extension to the Channel Ids | 20120926 | |||
| 5 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | Identifier of the ABAP Messaging Channel | 20120926 | |||
| 6 | I_CLIENT | Call by reference | Type reference (TYPE) | AMC_CLIENT_RANGE | Range Table for Clients | 20120926 | |||
| 7 | I_DATE_FROM | Call by reference | Type reference (TYPE) | SYDATS | (8-character) Date for SYST | 20120926 | |||
| 8 | I_DATE_TO | Call by reference | Type reference (TYPE) | SYDATS | (8-character) Date for SYST | 20120926 | |||
| 9 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE_RANGE | Range Table for AMC Role | 20120926 | |||
| 10 | I_SCOPE | Call by reference | Type reference (TYPE) | AMC_CHANNEL_SCOPE | Scope of an AMC channel | 20130131 | |||
| 11 | I_STATUS | Call by reference | Type reference (TYPE) | AMC_STATUS_UI_RANGE | Range Table for AMC Status | 20120926 | |||
| 12 | I_STATUS_CODE | Call by reference | Type reference (TYPE) | AMC_STATUS_RANGE | Range Table for AMC Status | 20120926 | |||
| 13 | I_TIME_FROM | Call by reference | Type reference (TYPE) | SYUZEIT | Field of type TIMS | 20120926 | |||
| 14 | I_TIME_TO | Call by reference | Type reference (TYPE) | SYUZEIT | Field of type TIMS | 20120926 | |||
| 15 | I_USER | Call by reference | Type reference (TYPE) | AMC_USER_RANGE | Range table for users | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120917 |
Method READ_LOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_LOG_ENTRIES | Call by reference | Type reference (TYPE) | AMC_LOG_ADMIN_TT | Table type for structure AMC_LOG_STORAGE | 20120926 | |||
| 2 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Channel Group Identifier | 20120926 | |||
| 3 | I_CHANNEL_EXTENSION_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_EXTENSION_ID | Extension to the Channel Ids | 20120926 | |||
| 4 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | Identifier of the ABAP Messaging Channel | 20120926 | |||
| 5 | I_CLIENT | Call by reference | Type reference (TYPE) | AMC_CLIENT_RANGE | Range Table for Clients | 20120926 | |||
| 6 | I_EXP_TIME | Call by reference | Type reference (TYPE) | INT4 | 10 | Natural number | 20120926 | ||
| 7 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE_RANGE | Range Table for AMC Role | 20120926 | |||
| 8 | I_SCOPE | Call by reference | Type reference (TYPE) | AMC_CHANNEL_SCOPE | Scope of an AMC channel | 20130131 | |||
| 9 | I_USER | Call by reference | Type reference (TYPE) | AMC_USER_RANGE | Range table for users | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120917 |
Method READ_OWN_LOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_LOG_ENTRIES | Call by reference | Type reference (TYPE) | AMC_LOG_ADMIN_TT | Table type for structure AMC_LOG_STORAGE | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120917 |
Method REORG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_REORG_LOGS | Call by reference | Type reference (TYPE) | I | Number of deleted logs | 20120926 | |||
| 2 | I_CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | SAP Client ID | 20120926 | |||
| 3 | I_EXP_TIME | Call by reference | Type reference (TYPE) | I | CO_AMC_LIFEIME | Reorg time in hours | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120917 |
Method WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_AMC_MSG_EPP_ATTR | Call by reference | Type reference (TYPE) | AMC_MESSAGE_EPP_ATTR | Attributes of EPP for AMC | 20120926 | |||
| 2 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Channel Identifier | 20120926 | |||
| 3 | I_CHANNEL_EXTENSION_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_EXTENSION_ID | Extension to the Channel Ids | 20120926 | |||
| 4 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | Identifier of the ABAP Messaging Channel | 20120926 | |||
| 5 | I_ENTRY_COUNTER | Call by reference | Type reference (TYPE) | INT4 | Log entry counter (to get the log entries unique) | 20120926 | |||
| 6 | I_ENTRY_ID | Call by reference | Type reference (TYPE) | SYSUUID_C32 | Log entry ID (to get the log entries unique) | 20120926 | |||
| 7 | I_EXP_TIME | Call by reference | Type reference (TYPE) | INT4 | CO_AMC_LIFEIME | Lifetime of Log-Entry in hours | 20120926 | ||
| 8 | I_LOG_TEXT | Call by reference | Type reference (TYPE) | STRING | obligatory field if the status-code is generic log text | 20120926 | |||
| 9 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE | AMC role, i.e. producer or consumer | 20120926 | |||
| 10 | I_STATUS | Call by reference | Type reference (TYPE) | AMC_LOG_STATUS_UI | AMC log status (successful, erroneous, etc.) | 20120926 | |||
| 11 | I_STATUS_CODE | Call by reference | Type reference (TYPE) | AMC_LOG_STATUS | AMC log status code (see CL_AMC_LOGGING=>_FILL_STATUS_INFO) | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120917 |
Method _AUTHORITY_CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ACTION | Call by reference | Type reference (TYPE) | AMC_AUTH_ACTION | Actions for AMC-Logging authorization | 20120926 | |||
| 2 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Application identifier | 20130101 | |||
| 3 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | Identifier of the ABAP Messaging Channel | 20130101 | |||
| 4 | I_SCOPE | Call by reference | Type reference (TYPE) | AMC_SCOPE | Scope | 20130101 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120505 |
Method _AUTH_CHECK_4_READ_OWN_LOG Signature
Method _AUTH_CHECK_4_READ_OWN_LOG on class CL_AMC_LOGGING has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20130102 |
Method _DEACTIVATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Channel Application identifier | 20130101 | |||
| 2 | I_CHANNEL_EXTENSION_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_EXTENSION_ID | 20130101 | ||||
| 3 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | 20130101 | ||||
| 4 | I_CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | Client ID of Current User | 20130101 | |||
| 5 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE | 20130101 | ||||
| 6 | I_USER | Call by reference | Type reference (TYPE) | SYUNAME | 20130101 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20130101 |
Method _FILL_STATUS_INFO Signature
Method _FILL_STATUS_INFO on class CL_AMC_LOGGING has no parameter.
Method _FILL_STATUS_INFO on class CL_AMC_LOGGING has no exception.
Method _GET_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | Client ID of Current User | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120423 |
Method _GET_LOG_ADMIN_PROPERTIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_RC | Call by reference | Type reference (TYPE) | SYTABIX | RC = 0, it exists log entry; RC > 0, no entry found | 20120926 | |||
| 2 | I_APPLICATION_ID | Call by reference | Type reference (TYPE) | AMC_APPLICATION_ID | ABAP Messaging Channel Identifier | 20120926 | |||
| 3 | I_CHANNEL_ID | Call by reference | Type reference (TYPE) | AMC_CHANNEL_ID | Identifier of the ABAP Messaging Channel | 20131205 | |||
| 4 | I_ROLE | Call by reference | Type reference (TYPE) | AMC_ROLE | AMC role, i.e. producer or consumer | 20120926 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | AMC logging error handling class | 20120423 |
Method _GET_SAP_CLIENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_CLIENTS | Value transfer | Type reference (TYPE) | AMC_CLIENT_TT | Table Type for SAP Clients | 20121005 |
Method _GET_SAP_CLIENTS on class CL_AMC_LOGGING has no exception.
Method _IS_CLIENT_INDEPENDENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_CLIENT_INDEPENDENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | "X" --> Client independent | 20120926 |
Method _IS_CLIENT_INDEPENDENT on class CL_AMC_LOGGING has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 805 |