BADI enhancement for Enjoy PO Tcodes at "header level".

Question

I could successfully add an item level tab to MEXXN PO tcodes. Somebody help me with the ME_GUI_PO_CUST and ME_PROCESS_PO implementations to add a customer field , say ZZ_ETYP in a separate header level tab "Expense type".
Do I need to add subscreen2 attribute to the implementing class ?
Will one structure do for both header and item level data ?
Do I need to create a separate table ( like ZMEPO_BADI_EXAMPL for items ) for the header also ?
It would be gr8 if i could get the code for the above BADIs and MEPOBADIEX's function modules.

Answer 1

Dear Iyer,
Kindly go through the code.. hope this will help you...
<b>DETAILED DATABASE DESIGN SPECIFICATIONS</b>
<b>1. ZTPTP_HEADER</b>
Header: Expense Type
Field Name     Field Type     Key Information     Field Description
MANDT     MANDT     X     Client
EBELN     EBELN     X     Purchasing Document Number
ZZ_EXPTYPE     ZZEXPTYPE          Expense Type
<b>2. ZTPTP_ITEM</b>
Item: Retainage
Field Name     Field Type     Key Information     Field Description
MANDT     MANDT     X     Client
EBELN     EBELN     X     Purchasing Document Number
EBELP     EBELP     X     Item Number of Purchasing Document
ZZ_RETAINAGE      ZZRETAINAGE           Retainage
<b>3. ZSPTP_HEADER</b>
PO Enhancement structure: Header
Field Name     Field Type     Key Information     Field Description
EBELN     EBELN          Purchasing Document Number
ZZ_EXPTYPE     ZZEXPTYPE          Expense Type
<b>4. ZSPTP_ITEM</b>
PO Enhancement structure: Item
Field Name     Field Type     Key Information     Field Description
EBELN     EBELN          Purchasing Document Number
EBELP     EBELP          Item Number of Purchasing Document
ZZ_RETAINAGE      ZZRETAINAGE           Retainage
Detailed logic
<b>LZPTP_PORETAINAGETOP (TOP INCLUDE) FG: ZPTP_PORETAINAGE</b>
persistent item data
data: git_persistent_data type sorted table of ztptp_item
                         with unique key mandt ebeln ebelp,
actual item data
      git_data            type sorted table of ztptp_item
                         with unique key mandt ebeln ebelp.
persistent header data
data: git_persistent_head type sorted table of ztptp_header
                         with unique key mandt ebeln ,
actual header data
      git_head            type sorted table of ztptp_header
                         with unique key mandt ebeln .
dynpro output structure
tables: zsptp_item,
        zsptp_header.
definitions required for dynpro/framework integration
data: ok-code type sy-ucomm.
Following is a SAP include.
include lmeviewsf01.
<b>1. ZPTP_COMMIT_HEADER FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_COMMIT. In this Function module we update the database table ZTPTP_HEADER i.e. as per a change / insert or delete command at the header level. This database table’s size will always be low. It just contains the PO s data just being edited or created.
The interface would look like:
     TABLES
      IMT_DATA_NEWHD STRUCTURE ZTPTP_HEADER
      IMT_DATA_OLDHD STRUCTURE ZTPTP_HEADER
      Comparing the old and new data we update 3 different internal tables and using these we can update the internal tables ZTPTP_HEADER before actually updating the database table EKKO.A similar logic is coded in the sample FM : MEPOBADIEX_COMMIT
<b>
2. ZPTP_COMMIT_ITEM FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_COMMIT. In this Function module we update the database table ZTPTP_HEADER i.e. as per a change / insert or delete command at the item level. This database table’s size will always be low. It just contains the PO s latest data just being edited or created.
The interface would look like :
     TABLES
       IMT_DATA_NEW STRUCTURE  ZTPTP_ITEM
  IMT_DATA_OLD STRUCTURE  ZTPTP_ITEM
      Comparing the old and new data we update 3 different internal tables and using these we can update the internal tables ZTPTP_HEADER before actually updating the database table EKPO. A similar logic is coded in the sample FM : MEPOBADIEX_COMMIT
<b>3. ZPTP_GET_DATA_HEADER FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_GET_DATA. This FM is responsible for updating an internal table (git_head) which would hold the data the user has changed or created or displayed till the current point of time. It would also hold the latest customer header data that is to be displayed in case of a change transaction.
The interface would be as follows:
Local Interface:
IMPORTING
     REFERENCE(IM_EBELN) TYPE  EBELN
     REFERENCE(IM_EBELP) TYPE  EBELP OPTIONAL
EXPORTING
     REFERENCE(EX_HEAD) TYPE  ZTPTP_HEADER
Read expense type from git_header. If not found, get expense value from EKKO.
<b>4. ZPTP_GET_DATA_ITEM FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_GET_DATA. This FM is responsible for updating an internal table (git_data) which would hold the data the user has changed or created or displayed till the current point of time. It would also hold the latest customer item data that is to be displayed in case of a change transaction.
The interface would be as follows:
Local Interface:
  IMPORTING
     REFERENCE(IM_EBELN) TYPE  EBELN
     REFERENCE(IM_EBELP) TYPE  EBELP
  EXPORTING
     VALUE(EX_DATA) TYPE  ZTPTP_ITEM
Read Retainage from git_data. If not found, get Retainage value from EKPO.
<b>5.  ZPTP_INIT FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_INIT. This FM is responsible for clearing the header and item internal tables.
clear: git_persistent_data[], git_data[],git_persistent_head[],git_head[].
<b>6. ZPTP_OPEN FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_OPEN.  This FM is responsible for existing information from respective database tables.
The interface would be as follows:
Local Interface:
IMPORTING
REFERENCE(IM_EBELN) TYPE  EBELN
Get Expense type and Retainage from customer created Tables and assign it to respective global internal tables.
<b>7.  ZPTP_POP_HEADER FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_POP. This FM is responsible for getting header values from screen fields.
The interface would be as follows:
Local Interface:
EXPORTING
   REFERENCE(EX_DYNP_DATAHD) TYPE  ZSPTP_HEADER
get dynpro data
  ex_dynp_datahd = zsptp_header.
<b>8.  ZPTP_POP_ITEM FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_POP. This FM is responsible for getting item values from screen fields.
The interface would be as follows:
Local Interface:
EXPORTING
   REFERENCE(EX_DYNP_DATA) TYPE  ZSPTP_ITEM
get dynpro data
  ex_dynp_data = zsptp_item.
<b>9.  ZPTP_POST_HEADER FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_POST. This FM is responsible for preparing header data for posting.
Local Interface:
IMPORTING
   VALUE(IM_EBELN) TYPE  EBELN
prepare customers data for posting
  check not im_ebeln is initial.
  lit_data_newhd[] = git_head.
  lit_data_oldhd[] = git_persistent_head.
  lwa_head-mandt = sy-mandt.
  lwa_head-ebeln = im_ebeln.
  modify lit_data_newhd from lwa_head transporting mandt ebeln where ebeln is initial.
Commit data in Database ztptp_header.
  call function 'ZPTP_COMMIT_HEADER'
    tables
      imt_data_newhd = lit_data_newhd
      imt_data_oldhd = lit_data_oldhd.
<b>10. ZPTP_POST_ITEM FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_POST. This FM is responsible for preparing item data for posting.
"Local Interface:
IMPORTING
    VALUE(IM_EBELN) TYPE  EBELN
  data: lwa_data like line of git_data,
        lit_data_new type standard table of ztptp_item,
        lit_data_old type standard table of ztptp_item.
prepare customers data for posting
  check not im_ebeln is initial.
  lit_data_new[] = git_data.
  lit_data_old[] = git_persistent_data.
  lwa_data-mandt = sy-mandt.
  lwa_data-ebeln = im_ebeln.
  modify lit_data_new from lwa_data transporting mandt ebeln where ebeln is initial.
Commit data in Database ztptp_item.
  call function 'ZPTP_COMMIT_ITEM' in update task
    tables
      imt_data_new = lit_data_new
      imt_data_old = lit_data_old.
<b>11.  ZPTP_PUSH_HEADER FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_PUSH. This FM is responsible for populating header values to screen fields.
Local Interface:
  IMPORTING
     REFERENCE(IM_DYNP_DATAHD) TYPE  ZSPTP_HEADER
set dynpro data
  zsptp_header = im_dynp_datahd .
<b>12.  ZPTP_PUSH_ITEM FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_PUSH. This FM is responsible for populating item values to screen fields.
Local Interface:
IMPORTING
   REFERENCE(IM_DYNP_DATA) TYPE  ZSPTP_ITEM
set dynpro data
  zsptp_item = im_dynp_data .
<b>13. ZPTP_SET_DATA_HEADER FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_SET_DATA. This FM is responsible for keep update header  information in git_header.
delete a line from git_data
    delete table git_head with table key mandt = sy-mandt
                                        ebeln = im_datahd-ebeln.
update customer data
    read table git_head assigning <lf_datahd> with table key
                                        mandt = sy-mandt
                                        ebeln = im_datahd-ebeln.
    if sy-subrc is initial.
update existing data
      <lf_datahd>-zz_exptype = im_datahd-zz_exptype.
    else.
make a new entry into the data table
      lwa_head = im_datahd.
      lwa_head-mandt = sy-mandt.
      insert lwa_head into table git_head.
    endif.
<b>14. ZPTP_SET_DATA_ITEM FG: ZPTP_PORETAINAGE</b>
Get the sample function module code from the standard FM: MEPOBADIEX_SET_DATA. This FM is responsible for keep update item information in git_data.
delete a line from git_data
    delete table git_data with table key mandt = sy-mandt
                                        ebeln = im_data-ebeln
                                        ebelp = im_data-ebelp.
update customer data
    read table git_data assigning <lf_data> with table key
                                        mandt = sy-mandt
                                        ebeln = im_data-ebeln
                                        ebelp = im_data-ebelp.
    if sy-subrc is initial.
update existing data
      <lf_data>-zz_retainage = im_data-zz_retainage.
    else.
make a new entry into the data table
      lwa_data = im_data.
      lwa_data-mandt = sy-mandt.
      insert lwa_data into table git_data.
    endif.
<b>DETAILED SCREEN DESIGN SPECIFICATIONS</b>
<b>screen 0002</b>
Item Retainage
ZSPTP_ITEM-ZZ_RETAINAGE     DEC     5     Retainage
Screen Logic / Process before Output
  call method call_view->handle_event( 'PBO' ).
Screen Logic / Process after Input
call method call_view->handle_event( 'PAI' )
<b>Screen 0003</b>
Header: Expense type
ZSPTP_HEADER-ZZ_EXPTYPE     NUMC     4     Expense Type
Screen Logic / Process before Output
  call method call_view->handle_event( 'PBO' ).
Screen Logic / Process after Input
call method call_view->handle_event( 'PAI' )
<b>DETAILED CLASS DESIGN SPECIFICATIONS</b>
<b>A. ZCL_IM_ME_GUI_PO_CUST</b>
Description
Imp. Class ZME_GUI_PO_CUST
Attributes
Name     Level     Visibility     Type
SUBSCREEN1     Constant     Public     MEPO_NAME
SUBSCREEN2     Constant     Public     MEPO_NAME
DYNP_DATA_PBO     Instance Attribute     Private     ZSPTP_ITEM
DYNP_DATA_PAI     Instance Attribute     Private     ZSPTP_ITEM
DYNP_DATA_PBOHD     Instance Attribute     Private     ZSPTP_HEADER
DYNP_DATA_PAIHD     Instance Attribute     Private     ZSPTP_HEADER
Methods
Name     Level     Visibility
IF_EX_ME_GUI_PO_CUST~SUBSCRIBE     Instance Attribute     Public
IF_EX_ME_GUI_PO_CUST~MAP_DYNPRO_FIELDS     Instance Attribute     Public
IF_EX_ME_GUI_PO_CUST~TRANSPORT_FROM_MODEL     Instance Attribute     Public
IF_EX_ME_GUI_PO_CUST~TRANSPORT_TO_DYNP     Instance Attribute     Public
IF_EX_ME_GUI_PO_CUST~TRANSPORT_FROM_DYNP     Instance Attribute     Public
IF_EX_ME_GUI_PO_CUST~TRANSPORT_TO_MODEL     Instance Attribute     Public
<b>1. SUBSCRIBE</b>
Description
Publisch Customer's Own Screens
Detailed logic
  when lc_item.
the name is a unique identifier for the subscreen and defined in this class definition
  lwa_subscriber-name = subscreen1.
the dynpro number to use
  lwa_subscriber-dynpro = '0002'.
the program where the dynpro can be found
  lwa_subscriber-program = 'SAPLZPTP_PORETAINAGE'.
each subscreen needs his own DDIC-Structure
  lwa_subscriber-struct_name = 'ZSPTP_ITEM'.
a label can be defined
  lwa_subscriber-label = text-001.
the position within the tabstrib can be defined
  lwa_subscriber-position = 1.
  lwa_subscriber-height = 7.
  append lwa_subscriber to re_subscribers.
Header subscreen
  when lc_header.
the name is a unique identifier for the subscreen and defined in this class definition
  lwa_subscriber-name = subscreen2.
the dynpro number to use
  lwa_subscriber-dynpro = '0003'.
the program where the dynpro can be found
  lwa_subscriber-program = 'SAPLZPTP_PORETAINAGE'.
each subscreen needs his own DDIC-Structure
  lwa_subscriber-struct_name = 'ZSPTP_HEADER'.
a label can be defined
  lwa_subscriber-label = text-002.
the position within the tabstrib can be defined
  lwa_subscriber-position = 1.
  lwa_subscriber-height = 7.
  append lwa_subscriber to re_subscribers.
  endcase.
<b>2. MAP_DYNPRO_FIELDS</b>
Description
Build Up Field Catalog
Detailed logic
  loop at ch_mapping assigning <lf_mapping>.
*Assignment of metafields to the customer fields.
    case <lf_mapping>-fieldname.
      when 'EBELN'.       <lf_mapping>-metafield = mmmfd_preq_no_po.
      when 'EBELP'.       <lf_mapping>-metafield = mmmfd_preq_item_po.
      when 'ZZ_RETAINAGE'. <lf_mapping>-metafield = mmmfd_cust_01.
      when 'ZZ_EXPTYPE'.   <lf_mapping>-metafield = mmmfd_cust_02.
    endcase.
  endloop.
<b>
3. TRANSPORT_FROM_MODEL</b>
Description
Data Transport from Business Object
Detailed logic
    when subscreen1.
Get the item object
      mmpur_dynamic_cast lif_item im_model.
      check not lif_item is initial.
      lwa_mepoitem = lif_item->get_data( ).
transport customer fields
      call function 'ZPTP_GET_DATA_ITEM'
        exporting
          im_ebeln = lwa_mepoitem-ebeln
          im_ebelp = lwa_mepoitem-ebelp
        importing
          ex_data  = lwa_customer.
store info for later use
      move-corresponding lwa_mepoitem to dynp_data_pbo.
      move lwa_customer-zz_retainage to dynp_data_pbo-zz_retainage.
    when subscreen2.
Get the header object
      mmpur_dynamic_cast lif_header im_model.
      check not lif_header is initial.
transport standard fields
      lwa_mepohead = lif_header->get_data( ).
transport customer fields
      call function 'ZPTP_GET_DATA_HEADER'
        exporting
          im_ebeln = lwa_mepohead-ebeln
        importing
          ex_head  = lwa_customerhd.
store info for later use
      move-corresponding lwa_mepohead to dynp_data_pbohd.
      if not lwa_customerhd-zz_exptype is initial.
        move lwa_customerhd-zz_exptype to dynp_data_pbohd-zz_exptype.
      else.
        move dynp_data_paihd-zz_exptype to dynp_data_pbohd-zz_exptype.
      endif.
    when others.
  endcase.
<b>4. TRANSPORT_TO_DYNP</b>
Description
Data Transport to Screen
Detailed logic
case im_name.
    when subscreen1 .
   Pushing item data to screen fields
      call function 'ZPTP_PUSH_ITEM'
        exporting
          im_dynp_data = dynp_data_pbo.
    when subscreen2 .
   Pushing header data to screen fields
      call function 'ZPTP_PUSH_HEADER'
        exporting
          im_dynp_datahd = dynp_data_pbohd.
    when others.
  endcase.
<b>5. TRANSPORT_FROM_DYNP</b>
Description
Data Transport from Screen
Detailed logic
case im_name.
    when subscreen1.
Getting item data from screen fields
      call function 'ZPTP_POP_ITEM'
        importing
          ex_dynp_data = dynp_data_pai.
      if dynp_data_pai ne dynp_data_pbo
       or dynp_data_paihd ne dynp_data_pbohd.
If data  changed we have to notify the framework
to transport data to the model
        re_changed = mmpur_yes.
    endif.
    when subscreen2.
Getting header data from screen fields
      call function 'ZPTP_POP_HEADER'
        importing
          ex_dynp_datahd = dynp_data_paihd.
      if dynp_data_paihd ne dynp_data_pbohd
      or dynp_data_pai ne dynp_data_pbo.
If data changed we have to notify the framework
to transport data to the model
        re_changed = mmpur_yes.
      endif.
    when others.
  endcase.
<b>6. TRANSPORT_TO_MODEL</b>
Description
Treatment of Function Codes
Detailed logic
  case im_name.
    when subscreen1.
is it an item? im_model can be header or item.
      mmpur_dynamic_cast lif_item im_model.
      check not lif_item is initial.
      lwa_mepoitem = lif_item->get_data( ).
standard fields changed?
      if dynp_data_pbo-ebeln ne dynp_data_pai-ebeln  or
         dynp_data_pbo-ebelp ne dynp_data_pai-ebelp or
         dynp_data_pbo-zz_retainage ne dynp_data_pai-zz_retainage.
update standard fields
        lwa_mepoitem-ebeln = dynp_data_pai-ebeln.
        lwa_mepoitem-ebelp = dynp_data_pai-ebelp.
        lwa_mepoitem-zzretainage = dynp_data_pai-zz_retainage.
        call method lif_item->set_data( lwa_mepoitem ).
      endif.
customer fields changed?
      if dynp_data_pbo-zz_retainage ne dynp_data_pai-zz_retainage.
        call function 'ZPTP_GET_DATA_ITEM'
          exporting
            im_ebeln = lwa_mepoitem-ebeln
            im_ebelp = lwa_mepoitem-ebelp
          importing
            ex_data  = lwa_customer.
        lwa_customer-zz_retainage = dynp_data_pai-zz_retainage.
Commit changes to database.
        call function 'ZPTP_SET_DATA_ITEM'
          exporting
            im_data = lwa_customer.
      endif.
    when subscreen2.
is it an header? im_model can be header or item.
      mmpur_dynamic_cast lif_header im_model.
      check not lif_header is initial.
      lwa_mepohead = lif_header->get_data( ).
standard fields changed?
      if dynp_data_pbohd-ebeln ne dynp_data_paihd-ebeln or
      dynp_data_pbohd-zz_exptype ne dynp_data_paihd-zz_exptype.
update standard fields
        lwa_mepohead-ebeln = dynp_data_paihd-ebeln.
        lwa_mepohead-zzexptype = dynp_data_paihd-zz_exptype.
        call method lif_header->set_data( lwa_mepohead ).
      endif.
customer fields changed?
      if dynp_data_pbohd-zz_exptype ne dynp_data_paihd-zz_exptype.
        call function 'ZPTP_GET_DATA_HEADER'
          exporting
            im_ebeln = lwa_mepohead-ebeln
          importing
            ex_head  = lwa_customerhd.
        lwa_customerhd-zz_exptype = dynp_data_paihd-zz_exptype.
Commit changes to database.
        call function 'ZPTP_SET_DATA_HEADER'
          exporting
            im_datahd = lwa_customerhd.
      endif.
    when others.
  endcase.
<b>
B. ZCL_IM_ME_PROCESS_PO_CUST</b>
Description
Imp. Class for BAdI imp. ZME_PROCESS_PO_CUST
Methods
Name     Level     Visibility
IF_EX_ME_PROCESS_PO_CUST~INITIALIZE     Instance Attribute     Public
IF_EX_ME_PROCESS_PO_CUST~OPEN     Instance Attribute     Public
IF_EX_ME_PROCESS_PO_CUST~PROCESS_HEADER     Instance Attribute     Public
IF_EX_ME_PROCESS_PO_CUST~PROCESS_ITEM     Instance Attribute     Public
IF_EX_ME_PROCESS_PO_CUST~POST     Instance Attribute     Public
IF_EX_ME_PROCESS_PO_CUST~CLOSE     Instance Attribute     Public
<b>
1. INITIALIZE</b>
Description
Initializations (Invoked Once Only)
Detailed logic
initializations
  call function 'ZPTP_INIT'.
<b>2. OPEN</b>
Description
Open a Purchase Order
Detailed logic
data: lwa_mepoheader type mepoheader.
read customer data
this has to be done when we open a persistent object
  check im_trtyp eq 'V' or im_trtyp eq 'A'.
  lwa_mepoheader = im_header->get_data( ).
read customer data from database
  call function 'ZPTP_OPEN'
    exporting
      im_ebeln = lwa_mepoheader-ebeln.
<b>3. PROCESS_HEADER</b>
Description
Processing of Header Data
Detailed logic
data: lwa_mepohead type mepoheader,
        lwa_customerhd type ztptp_header.
  include mm_messages_mac. "useful macros for message handling
here we check customers data
  lwa_mepohead = im_header->get_data( ).
  if lwa_mepohead-loekz eq 'D'.
a physical deletion of the header was carried out.
    lwa_customerhd-ebeln = lwa_mepohead-ebeln.
    call function 'ZPTP_SET_DATA_HEADER'
      exporting
        im_datahd                  = lwa_customerhd
        im_physical_delete_request = 'X'.
  endif.
<b>4. PROCESS_ITEM</b>
Description
Processing of Item Data
Detailed logic
data: lwa_mepoitem type mepoitem,
        lwa_customer type ztptp_item.
  include mm_messages_mac. "useful macros for message handling
here we check customers data
  lwa_mepoitem = im_item->get_data( ).
  if lwa_mepoitem-loekz eq 'D'.
a physical deletion of the item was carried out. therrefor we have to
delete customer data on the level of the item
    lwa_customer-ebeln = lwa_mepoitem-ebeln.
    lwa_customer-ebelp = lwa_mepoitem-ebelp.
    call function 'ZPTP_SET_DATA_ITEM'
      exporting
        im_data                    = lwa_customer
        im_physical_delete_request = 'X'.
  endif.
<b>5. POST</b>
Description
Post
Detailed logic
*Posting header data
      call function 'ZPTP_POST_HEADER'
        exporting
          im_ebeln       = im_ebeln.
*Posting item data
      call function 'ZPTP_POST_ITEM'
        exporting
          im_ebeln       = im_ebeln.
<b>
6. CLOSE</b>
Description
Closing Processing
Detailed logic
close customer data
  call function 'ZPTP_INIT'.