SAP ABAP IMG Activity BADI_RECA_SEARCH_HEL (Implement Enhancements (BAdI): Search Help)
Hierarchy
EA-FIN (Software Component) EA-FIN
   RE-FX (Application Component) Flexible Real Estate Management
     RE_CA_AP (Package) RE: Application Components (Application-Related Objects)
IMG Activity
ID BADI_RECA_SEARCH_HEL Implement Enhancements (BAdI): Search Help  
Transaction Code S_EE6_85000199   (empty) 
Created on 20111123    
Customizing Attributes BADI_RECA_SEARCH_HEL   Implement Enhancements (BAdI): Search Help 
Customizing Activity BADI_RECA_SEARCH_HEL   Implement Enhancements (BAdI): Search Help 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name BADI_RECA_SEARCH_HELP    

Use

You have special requirements related to the way search helps function, for example you want to use search helps that

  • Display only those objects for which the user has authorization
  • Do not display objects that are no longer valid
  • Do not display objects that are flagged for deletion or for which the deletion indicator is set

Requirements

You are using a search help that calls the BAdI, that is, a search help that uses a search help exit that calls the module RECA_SEARCH_HELP_CALL_BADI. This could be, for example, the exit module RECA_SEARCH_HELP_F4UT_OPT_COLW or RECA_SEARCH_HELP_OUT_AGREEMENT.

Standard settings

Activities

If you want to use the BAdI, first determine if the BAdI is called in the search helps that are involved. That is, you have to determine if the individual search helps use an appropriate search help exit. If this is the case, implement the BAdI. The following example implementations are available:

CL_EXM_IM_RECA_SEARCH_HELP_VAL

CL_EXM_IM_RECA_SEARCH_HELP

If a suitable search help is not available in the standard system, you can create your own customer-specific individual search help. The prerequisite for using the modification-free enhancement described is that the search help you use is a collective search help.

  • Create an elementary search help, such as ZREBDBUNOA, in the customer name space. Creating the search help is easiest if you use an existing elementary search help as a template, such as REBDBUNOA (example for buildings) and copy the template (SE11). Change the descriptive text in your copy. Make sure that your search help contains the technical field OBJNR (object number). As the search help exit, enter one of the function modules that call the BAdI: RECA_SEARCH_HELP_F4UT_OPT_COLW (BAdI call and column optimization) or direct RECA_SEARCH_HELP_CALL_BADI (call of BAdI only), as an alternative for contracts also RECA_SEARCH_HELP_OUT_AGREEMENT. Activate your search help.
  • Now enhance the collective search help so that your new search help is called:

    Call the collective search help using SE12 (example for buildings: REBDBUNO) and choose Goto -> Append Search Help. Assign a (new) name in the customer namespace, for example, ZZREBDBUNOA. Enter your newly created search help ZREBDBUNOA as included search help in ZZREBDBUNOA. Assign the parameters. Activate the collective search help.

    You can now test this search help. As long as you only copied the search help and did not change it, and the BAdI is also not implemented, then your search help works the same as the template.

  • To implement the BAdI, call transaction SE18 for the BAdI BADI_RECA_SEARCH_HELP and create an implementation. For example, in your search help ZREBDBUNOA, if you want to display only buildings that are not flagged for deletion and where the validity ended 6 months ago, you can copy the example class CL_EXM_IM_RECA_SEARCH_HELP_VAL.
  • Change the code of your implementation to meet your requirements. Be aware that the BAdI is called in all search helps that possess one of the search help exits mentioned above. That means, you have to ensure that the implementation contains appropriate queries of those search help names for which it works, in order to prevent terminations in object types that are not covered by your implementation. In the case of the implementation class CL_EXM_IM_RECA_SEARCH_HELP_VAL, different objects can be handled with the same code, since the validity check functions not only for buildings, but also, for example, for rental objects, contracts and so on.
  • Activate your BAdI implementation and test if the F4 help works correctly.

Tip

If you want to deactivate elementary standard search helps, then enter their names as included search help in the append, and set the "Hide" indicator. In this way, you can replace standard search helps with your own customer-specific search helps.

Notes for Developers

Example

Business Attributes
ASAP Roadmap ID 257   Create User Exits 
Mandatory / Optional 3   Nonrequired activity 
Critical / Non-Critical 1   Critical 
Country-Dependency A   Valid for all countries 
Maintenance Objects
Maintenance object type E   Business Add-In - Definition 
History
Last changed by/on SAP  20111123 
SAP Release Created in 606