SAP ABAP IMG Activity BADI_CCM_CLIST_CBTNS (Add-In: Implement Customer-Specific Buttons)
Hierarchy
☛ ECC-DIMP (Software Component) DIMP
   ⤷ IS-AD-LBK (Application Component) R/3 Log Book
     ⤷ DI_CCM_CMPLIST_AD (Package) DI: Configuration Control - Component List (A&D)
IMG Activity
ID BADI_CCM_CLIST_CBTNS Add-In: Implement Customer-Specific Buttons  
Transaction Code S_KA5_12001298   (empty) 
Created on 20021127    
Customizing Attributes BADI_CCM_CLIST_CBTNS   Implement Customer-Specific Buttons 
Customizing Activity BADI_CCM_CLIST_CBTNS   Implement Customer-Specific Buttons 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name BADI_CCM_CLIST_CBTNS    

Use

This Business Add-In (BAdI) is used in the Component List.

This Add-In enables you to make customer-specific changes to the user interface by adding up to three customer buttons and the related processing.

During implementation, the BAdI enables execution of customer-specific functionality inside the Component List simply by pressing the corresponding button in the ALV grid. It is up to the customer to determine how many, in which layout, and with which functionality these buttons should be executed.

The active customer buttons appear to the right of the standard Component List buttons, preceded by a separator.

SAP enables implementation of up to three different buttons. Three different methods are related to each of them.

Requirements

  • An active BAdI implementation is necessary to enable you to use the customer buttons. This means that a customer button is only contained in the Component List if an active BAdI implementation exists and at least one button has been activated.
  • The function codes of the customer buttons are defined as C_ACT1, C_ACT, and C_ACT3. If structure RS_STB_BUTTON_x contains a (different) value, it is automatically overwritten with the above-mentioned function codes.
  • Currently, only the following button types (field STB_BUTTON in structure RS_STB_BUTTON_x) are supported:
    • '0' = Button (normal)
    • '3' = Separator

Standard settings

SAP does not provide a default or sample implementation.

Activities

For more information about this procedure, see the SAP Library under

  • Basis Components -> ABAP Workbench -> Changing the SAP Standard -> Business Add-Ins -> Implementing Business Add-Ins.

In order to implement the customer button(s) proceed as follows:

  • Activate the button(s) that are to be implemented by setting the checkbox variable RV_BUTTONx_ON in method ACTIVATE_CBTN_x.
  • Define the button layout using method SET_CBTN_x_LAYOUT by filling in the 'returning' structure accordingly.
  • Program the relevant functionality by filling in method PROCESS_CBTN_x.

Example

Further notes

You can also call the documentation on the BAdI method via the menu, by carrying out the following steps:

  1. Choose the tab page Interface.
  2. Double-click on the relevant method.
  3. Click on the right mouse button and choose Component documentation.

The Business Add-In contains the following methods:

  • ACTIVATE_CBTN_1 (Activate Customer Button 1)
  • ACTIVATE_CBTN_2 (Activate Customer Button 2)
  • ACTIVATE_CBTN_3 (Activate Customer Button 3)
  • SET_CBTN_1_LAYOUT (Set Text / Icon / Quick Info for Customer Button 1)
  • SET_CBTN_2_LAYOUT (Set Text / Icon / Quick Info for Customer Button 2)
  • SET_CBTN_3_LAYOUT (Set Text / Icon / Quick Info for Customer Button 3)
  • PROCESS_CBTN_1 (Execute customer function for Customer Button 1)
  • PROCESS_CBTN_2 (Execute customer function for Customer Button 2)
  • PROCESS_CBTN_3 (Execute customer function for Customer Button 3)

The following parameters are provided in the interfaces of the relevant methods:

(Note: 'x' is used as a synonym for '1', '2' and '3' in the corresponding methods and/or parameters.)

  • RV_BUTTONx_ON is a checkbox variable for method ACTIVATE_CBTN_x. If the flag is set, this indicates that button 'x' is active and should be displayed. The relevant coding should be executed in the Component List.
    Note that the methods SET_CBTN_x_LAYOUT and PROCESS_CBTN_x are performed only if the corresponding flag RV_BUTTONx_ON is set for the relevant button.
  • RS_STB_BUTTON_x is a structure for a toolbar button and is used in method SET_CBTN_x_LAYOUT. Returning structure RS_STB_BUTTON_x defines the layout/attributes (icon, quick info, button type, disabled, text) of button 'x'.
  • CLIST_GUI contains the instance of the relevant GUI layer of the read Component List and is used as an importing parameter for method PROCESS_CBTN_x. Via this object reference it is possible to modify the data in the Component List ALV grid (table OUTTAB), for instance by using the public methods T_OUTTAB and SET_OUTTAB of class L_CCM_CLIST_GUI.
  • CUR_ROW is related to the actual cursor position (contains the 'Row on Grid').
  • CUR_VALUE is related to the actual cursor position (contains the 'Field Value').
  • CUR_COL is related to the actual cursor position (contains the 'Column on Grid').
  • CUROW_ID is related to the actual cursor position (contains the 'Row ID').
  • CUR_COL_ID is related to the actual cursor position (contains the 'Column ID').
  • CUR_ROW_NO is related to the actual cursor position (contains the 'Assignment of line number to line ID').
  • CUR_INDEX_ROWS is related to the actual cursor position (contains the 'Indexes of Selected Rows').
  • CUR_T_ROW_NO is related to the actual cursor position (contains the 'Numeric IDs of Selected Rows').

Business Attributes
ASAP Roadmap ID 204   Establish Functions and Processes 
Mandatory / Optional 2   Optional activity 
Critical / Non-Critical 2   Non-critical 
Country-Dependency A   Valid for all countries 
Assigned Application Components
Documentation Object Class Documentation Object Name Current line number Application Component Application Component Name
SIMG BADI_CCM_CLIST_CBTNS 0 KA50002452 Configuration Control 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20030225 
SAP Release Created in 471