Error Engine

[Former Member]

In this blog I would like to talk about a generic error engine class which can be used for error handling in any application.This class can be used to add errors,save to database and also display the errors either directly on the screen or through an "Error" button created dynamically on the screen title bar.This class uses SAP's application log concept for error handling.

Part 1 : Creation of class ZERROR_ENGINE
        PUBLIC SECTION  class ZERROR_ENGINE definition  public  final  create public .*"* public components of class ZERROR_ENGINE*"* do not include other source files here!!!public section.  methods CONSTRUCTOR    importing      value(I_OBJECT) type BALOBJ_D      value(I_SUBOBJECT) type BALSUBOBJ optional      value(I_LOGNUMBER) type BALNREXT optional    raising      CX_ECATT_LOG .  methods MESSAGE_TO_APPLICATION_LOG    importing      value(I_ID) type SYMSGID      value(I_TYPE) type SYMSGTY      value(I_NUMBER) type SYMSGNO      value(I_MSGV1) type SYMSGV optional      value(I_MSGV2) type SYMSGV optional      value(I_MSGV3) type SYMSGV optional      value(I_MSGV4) type SYMSGV optional    raising      CX_ECATT_LOG .  methods FREE_MESSAGE_TO_APPL_LOG    importing      !I_TYPE type SYMSGTY      !I_TEXT type STRING    raising      CX_ECATT_LOG .  class-methods WRITE_TO_DB    raising      CX_ECATT_LOG .  class-methods DISPLAY_DIRECT    raising      CX_ECATT_LOG .  class-methods DISPLAY_ERROR_BUTTON    importing      !I_GRID type BOOLEAN optional .

    PRIVATE SECTIONprivate section.  data AT_APP_LOG type BAL_S_LOG .  data AT_APP_LOG_HANDLE type BALLOGHNDL .  data AT_LOG_OPEN type BOOLEAN .  data AT_MESSAGE type BAL_S_MSG .  class-data AT_LOG_HANDLE type BAL_T_LOGH .  constants CO_TRUE type BOOLEAN value 'X'. "#EC NOTEXT  constants CO_FALSE type BOOLEAN value SPACE. "#EC NOTEXT  class-data REF_TOOLBAR type ref to CL_GUI_TOOLBAR .  class-data AT_GRID type BOOLEAN value SPACE .  class-data AT_PROFILE type BAL_S_PROF .  class-methods ON_FUNCTION_SELECTED    for event FUNCTION_SELECTED of CL_GUI_TOOLBAR    importing      !FCODE .



          METHODSMETHOD constructor.  at_app_log-object    =   i_object.  at_app_log-subobject =   i_subobject.  at_app_log-extnumber =   i_lognumber.  CALL FUNCTION 'BAL_LOG_CREATE'    EXPORTING      i_s_log                 = at_app_log    IMPORTING      e_log_handle            = at_app_log_handle    EXCEPTIONS      log_header_inconsistent = 1      OTHERS                  = 2.  IF sy-subrc <> 0.    RAISE EXCEPTION TYPE cx_ecatt_log.  ELSE.    INSERT at_app_log_handle INTO TABLE at_log_handle.    at_log_open = co_true.  ENDIF.ENDMETHOD.METHOD message_to_application_log.  IF at_log_open = co_true.    CLEAR at_message.    at_message-msgty = i_type.    at_message-msgid = i_id.    at_message-msgno = i_number.    at_message-msgv1 = i_msgv1.    at_message-msgv2 = i_msgv2.    at_message-msgv3 = i_msgv3.    at_message-msgv4 = i_msgv4.    CALL FUNCTION 'BAL_LOG_MSG_CUMULATE'     EXPORTING       i_log_handle               = at_app_log_handle       i_s_msg                    = at_message       i_compare_attributes       = co_true       i_compare_context          = co_true       i_compare_parameters       = co_true*   IMPORTING*     E_S_MSG_HANDLE             =*     E_MSG_WAS_LOGGED           =*     E_MSG_WAS_DISPLAYED        =     EXCEPTIONS       log_not_found              = 1       msg_inconsistent           = 2       log_is_full                = 3       OTHERS                     = 4              .    IF sy-subrc <> 0.      RAISE EXCEPTION TYPE cx_ecatt_log.    ENDIF.  ELSE.    RAISE EXCEPTION TYPE cx_ecatt_log.  ENDIF.ENDMETHOD.METHOD free_message_to_appl_log.  DATA : v_text(255) TYPE c.  IF at_log_open = co_true.    v_text = i_text.    CALL FUNCTION 'BAL_LOG_MSG_ADD_FREE_TEXT'      EXPORTING       i_log_handle              =  at_log_handle        i_msgty                   = i_type*     I_PROBCLASS               = '4'        i_text                    = v_text*     I_S_CONTEXT               =*     I_S_PARAMS                =*   IMPORTING*     E_S_MSG_HANDLE            =*     E_MSG_WAS_LOGGED          =*     E_MSG_WAS_DISPLAYED       =     EXCEPTIONS       log_not_found             = 1       msg_inconsistent          = 2       log_is_full               = 3       OTHERS                    = 4              .    IF sy-subrc <> 0.      RAISE EXCEPTION TYPE cx_ecatt_log.    ENDIF.  ELSE.    RAISE EXCEPTION TYPE cx_ecatt_log.  ENDIF.ENDMETHOD.METHOD write_to_db.  IF LINES( at_log_handle ) > 0.    CALL FUNCTION 'BAL_DB_SAVE'     EXPORTING*         I_CLIENT               = SY-MANDT*         I_IN_UPDATE_TASK       = ' '       i_save_all             = 'X'       i_t_log_handle         = at_log_handle*       IMPORTING*         E_NEW_LOGNUMBERS       =     EXCEPTIONS       log_not_found          = 1       save_not_allowed       = 2       numbering_error        = 3       OTHERS                 = 4              .    IF sy-subrc <> 0.      RAISE EXCEPTION TYPE cx_ecatt_log.    ENDIF.  ELSE.    RAISE EXCEPTION TYPE cx_ecatt_log.  ENDIF.ENDMETHOD.METHOD display_direct.  DATA : v_gui_active  TYPE  c.  CALL FUNCTION 'GUI_IS_AVAILABLE'    IMPORTING      return = v_gui_active.  IF v_gui_active = co_true.    IF LINES( at_log_handle ) > 0.      CALL FUNCTION 'BAL_DSP_LOG_DISPLAY'        EXPORTING          I_S_DISPLAY_PROFILE  = at_PROFILE          i_t_log_handle       = at_log_handle        EXCEPTIONS          profile_inconsistent = 1          internal_error       = 2          no_data_available    = 3          no_authority         = 4          OTHERS               = 5.      IF sy-subrc <> 0.        RAISE EXCEPTION TYPE cx_ecatt_log.      ENDIF.    ENDIF.  ELSE.    RAISE EXCEPTION TYPE cx_ecatt_log.  ENDIF.ENDMETHOD.METHOD display_error_button.  DATA :  ref_container TYPE REF TO cl_gui_gos_container.*  ref_toolbar   TYPE REF TO cl_gui_toolbar.  DATA v_icon TYPE iconname.  DATA v_butn_type TYPE tb_btype.  DATA:v_quick TYPE iconquick,       myevent TYPE cntl_simple_event,       myevent_tab TYPE cntl_simple_events.  IF ref_container IS INITIAL.    CREATE OBJECT ref_container      EXPORTING        width             = 58        no_autodef_progid_dynnr = 'X'      EXCEPTIONS        OTHERS            = 5        .    CHECK sy-subrc = 0.    CREATE OBJECT ref_toolbar      EXPORTING parent = ref_container.    CALL FUNCTION 'ICON_CREATE'      EXPORTING        name       = 'ICON_ERROR_PROTOCOL'        add_stdinf = space      IMPORTING        RESULT     = v_icon      EXCEPTIONS        OTHERS     = 0.    v_quick = 'Error Engine'.    CALL METHOD ref_toolbar->add_button      EXPORTING        fcode     = 'LOG'        icon      = v_icon        butn_type = 0        quickinfo = v_quick.*Register the "Function Selected Event"    CLEAR myevent.    REFRESH : myevent_tab[].    myevent-eventid = cl_gui_toolbar=>m_id_function_selected.    myevent-appl_event = 'X'.    APPEND myevent TO myevent_tab.    CALL METHOD ref_toolbar->set_registered_events      EXPORTING        events = myevent_tab.    at_grid = i_grid.    SET HANDLER zerror_engine=>on_function_selected                FOR ref_toolbar.  ENDIF.ENDMETHOD.METHOD on_function_selected.  IF fcode = 'LOG'.* get a prepared profile    CALL FUNCTION 'BAL_DSP_PROFILE_POPUP_GET'      IMPORTING        e_s_display_profile = at_profile      EXCEPTIONS        OTHERS              = 1.* use grid for display if wanted    at_profile-use_grid = at_grid.* set report to allow saving of variants    at_profile-disvariant-report = sy-repid.* when you use also other ALV lists in your report,* please specify a handle to distinguish between the display* variants of these different lists, e.g:    at_profile-disvariant-handle = 'LOG'.*Display the log as popup    TRY.        CALL METHOD zerror_engine=>display_direct          .      CATCH cx_ecatt_log .    ENDTRY.  ENDIF.ENDMETHOD.

Part 2 : Test program ZERROR_ENGINE_DEMO

Selection Screen

Displaying errors directly on the screen

Displaying errors through "Error Button"

   Source Code for test program*&---------------------------------------------------------------------**& Report  ZERROR_ENGINE_DEMO*&*&---------------------------------------------------------------------**&*&*&---------------------------------------------------------------------*REPORT  zerror_engine_demo.TABLES : usr01.*This report creates two entries in the application log*1.An entry for a end user ( subobject = 'USER'.)*2 An entry for an administrator(subobject = 'ADMIN')*The application log object 'ZOBJ' and the two subobjects*can be created by using the transaction 'SLGO'CONSTANTS : co_log_object TYPE balobj_d    VALUE 'ZOBJ',            co_log_subusr TYPE balsubobj   VALUE 'USER',            co_log_subadm TYPE balsubobj   VALUE 'ADMIN',            co_msg_id     TYPE symsgid     VALUE 'ZLOG',            co_msg_tp_inf TYPE symsgty     VALUE 'W',            co_msg_tp_err TYPE symsgty     VALUE 'E',            co_msg_nr_admin TYPE symsgno   VALUE '001',            co_msg_nr_user TYPE symsgno    VALUE '002'.DATA : gv_lognumber TYPE balnrext,       gv_bname     TYPE xubname,       ok_code      TYPE syucomm,       fcode        TYPE syucomm,       ref_user     TYPE REF TO zerror_engine, "User       ref_admin    TYPE REF TO zerror_engine. "AdminPARAMETERS : p_bname TYPE xubname.SELECTION-SCREEN BEGIN OF BLOCK b1 WITH FRAME TITLE text-001.PARAMETERS : p_dd RADIOBUTTON GROUP r1 DEFAULT 'X', "Display Direct            p_db  RADIOBUTTON GROUP r1.             "Display error button on screenSELECTION-SCREEN END OF BLOCK b1.PARAMETERS : p_save AS CHECKBOX.START-OF-SELECTION.  SELECT SINGLE bname FROM usr01 INTO gv_bname WHERE bname = p_bname.  IF sy-subrc NE 0.    gv_lognumber = p_bname.*Create log object for 'USER' and 'ADMN'.This should only be created*once in the program    CREATE OBJECT ref_user           EXPORTING i_object    = co_log_object                     i_subobject = co_log_subusr                     i_lognumber = gv_lognumber.    CREATE OBJECT ref_admin          EXPORTING i_object    = co_log_object                    i_subobject = co_log_subusr                    i_lognumber = gv_lognumber.*Add 1 message each for the 'USER' and the 'ADMN'.    CALL METHOD ref_user->message_to_application_log      EXPORTING        i_id     = co_msg_id        i_type   = co_msg_tp_inf        i_number = co_msg_nr_user        i_msgv1  = 'Could not find user(FOR USER)'.    CALL METHOD ref_admin->message_to_application_log      EXPORTING        i_id     = co_msg_id        i_type   = co_msg_tp_err        i_number = co_msg_nr_admin        i_msgv1  = 'Could not find user(FOR ADMIN)'.    IF p_save = 'X'.**Store both the messages to the database      CALL METHOD zerror_engine=>write_to_db( ).    ENDIF.    IF p_dd = 'X'. "Display error log directly on the screen*Display the message directly on the screen      CALL METHOD zerror_engine=>display_direct( ).    ELSE.*Display log through "Error" button on the screen.      CALL METHOD zerror_engine=>display_error_button        EXPORTING          i_grid = 'X'.      CALL SCREEN 100.    ENDIF.  ENDIF.*&---------------------------------------------------------------------**&      Module  STATUS_0100  OUTPUT*&---------------------------------------------------------------------**       text*----------------------------------------------------------------------*MODULE status_0100 OUTPUT.  SET PF-STATUS 'BASIC'.  SET TITLEBAR '007'.ENDMODULE.                 " STATUS_0100  OUTPUT*&---------------------------------------------------------------------**&      Module  EXIT_PROCESSING  INPUT*&---------------------------------------------------------------------**       text*----------------------------------------------------------------------*MODULE exit_processing INPUT.  fcode = ok_code.  CLEAR ok_code.  CASE fcode.    WHEN 'BACK' OR 'EXIT' OR 'CANC'.      SET SCREEN 0.      LEAVE SCREEN.  ENDCASE.ENDMODULE.                 " EXIT_PROCESSING  INPUT