SAP ABAP IMG Activity WCF_CSEARCHV_OBJ (Define Central Search)
Hierarchy
WEBCUIF (Software Component) SAP Web UI Framework
   CA-WUI (Application Component) WebClient UI
     WCF_IMG_STRUCTURE (Package) Structure and Activities for WEBCUIF IMG
IMG Activity
ID WCF_CSEARCHV_OBJ Define Central Search  
Transaction Code S_A0F_96000068   (empty) 
Created on 20090424    
Customizing Attributes WCF_CSEARCHV_OBJ   Define Central Search 
Customizing Activity WCF_CSEARCHV_OBJ   Define Central Search 
Document
Document Class SIMG   Hypertext: Object Class - Class to which a document belongs.
Document Name WCF_CSEARCHV_OBJ    

Use

In this IMG activity, you can define the business objects that are supported by the central search, which is located in the header area of the WebClient UI.

You can use the central search to select single business objects, to search across all business objects that belong to a business role, and to select and execute saved searches. You can enter keywords, IDs, or free text in the search field to start the search, either across all business objects or for an individual business object (simple search).

Requirements

Standard settings

  • The following search parameter values are defined and delivered in the standard system. They apply unless you have defined different values in the active parameter profile assigned to your business role:
    • CNTRLSEARCH_UI_TYPE
      This defines the object type of the central search; the default value is '3'.
      Value '2' specifies that the central search consists of one dropdown box and one entry field; in the single dropdown box the user can select a combination of object type and search field; in the entry field he or she can enter a search value.
      Value '3' specifies that the central search consists of two dropdown boxes and one entry field; in the first dropdown box the user can select an object type and in the second dropdown box he or she can select an attribute; in the entry field the user can enter a search value.
    • SEARCH_MAX_HITS
      This defines the maximum number of data records that are displayed in the result list.

      You can define parameters in the IMG activity Define Parameters

  • In the standard system, typical search criteria for the various CRM business roles are delivered. If you want to adjust these standard search criteria to your needs, you can do so using this IMG activity and the UI configuration of the corresponding search views.
    For more information about how you can use the UI Configuration Tool, see SAP Library for Customer Relationship Management under Components and Functions -> Basic Functions -> UI Framework and Configuration -> UI Configuration Tool.

Activities

For all business objects that are to be supported by the central search, make the following Customizing settings:

  • Navigation bar profile
    Specifies the navigation bar profile of a business role
  • Object type
    Defines the navigation to the search component
  • Object action
    Specifies the navigation to the search component: A, D, F, or H
    This action is usually F, which means 'Execute', or H, which is used for the simple search.
  • UI component
    Defines the UI component name
  • Search view
    Defines the view in the corresponding UI component (if necessary)
  • Search context node
    Defines the context node that contains the advanced search, in the BSP Component Workbench (if necessary)
  • Dynamic search
    Defines the dynamic search used in the simple search. For entries of SAP NetWeaver Enterprise Search,
    the naming convention is <Template ID>_ESSearch, for example, CRM_PRODUCT_ESSearch.
  • Search criteria
    Defines additional predefined search criteria used in the simple search based on SAP NetWeaver Enterprise Search. The search criteria are optional and can be used if one template is used for different UI object types, for example, if BP_ACCOUNT and BP_ACCOUNT_CHM use the same template, but the UI object type needs additional search criteria. The naming convention is <Attribute name><Operator><Value>, for example, BP_GROUP=A;BP_KIND<>C.
  • Comment
    Describes the individual Customizing entry

How to Enhance the Central Search with Custom Objects

If you want to enhance the central search with custom objects, you need to ensure that the inbound plug, of the underlying search component of the business object called during navigation, has been enhanced:

Insert a call to adjust_search_criteria_values( )in the affected search view controller, so that the user input is converted to valid key values. Override the method if the standard logic, which supports dropdown list boxes and value conversion, is not sufficient for you.

Example

Business Attributes
ASAP Roadmap ID 201   Make global settings 
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 WCF_CSEARCHV_OBJ 0 PNF0000011 WebClient UI 
Maintenance Objects
Maintenance object type C   Customizing Object 
Assigned objects
Customizing Object Object Type Transaction Code Sub-object Do not Summarize Skip Subset Dialog Box Description for multiple selections
CSEARCHV_OBJ V - View SM30  
History
Last changed by/on SAP  20090424 
SAP Release Created in 701