Page tree
Skip to end of metadata
Go to start of metadata

Use Case

This feature allows the administrator to define generic searches. These searches can be used in various functions, such as adding objects to folders.

Solution

Backend

Use transaction SE11 to find an existing search help or to create a new search help.  

Frontend

The configuration for a generic search has to be done in a default.txt
default.txt

# Search help
SAP.PLM.searchhelp.<SEARCH_HELP>.tabletype = <tabletype>
SAP.PLM.searchhelp.<SEARCH_HELP>.keyfields = <fields>

(warning) You have to upload the changed settings to Backend with admin function "Upload settings to SAP system".

(warning) Disclaimer: The key fields for the search helps are no "frozen" API from SAP. It can happen, that the field names changes between releases. (Example: search help "MAT1_ESH_TREX_BASIC")

Example

For example you are using the Enterprise Search and you want to use the search help for "Advanced Search for Material using Enterprise Search" from MM03 in ECTR as well:

Backend

Find in SE11 the name of the search help. In this example it is "MAT1_ESH_TREX_BASIC".

The marked name you will need in the frontend configuration. 

Frontend

You have to add some configuration:

Define the search help and the key field in (...)\default.txt

# Search help for advanced material search
# The result object will be a material. => ECTR-Type for material is "MARA"
SAP.PLM.searchhelp.MAT1_ESH_TREX_BASIC.tabletype = MARA
# The key of the object is returned by search help MAT1_ESH_TREX_BASIC in field MATNR
SAP.PLM.searchhelp.MAT1_ESH_TREX_BASIC.keyfields = MATNR

(info) To find out the key fields, you can execute the search help in SE11. The field with shows the key of the object is the key field:

If a object has more then one key field, you have to list them (e.g. "SAP.PLM.searchhelp./PLMI/GSS_MBOM_STALT_DB.keyfields = MATERIAL;PLANT;BOM_USAGE;ALTERNATIVE_BOM").

(warning) You have to upload the changed settings to Backend with admin function "Upload settings to SAP system".

Define the dictionary name of the function in (...)\customize\dictionary\en\customer.txt

# Search help for advanced material search
fnc.add.with.search.help(MAT1_ESH_TREX_BASIC) = Advanced Search for Material

Define the icon of the function in (...)\customize\aux-files\customer_icons.txt

# Search help for advanced material search
fnc.add.with.search.help(MAT1_ESH_TREX_BASIC) = {0}/sap/material<<{0}/sap/o_more

Add the function for the menu in \customize\config\menu_macros.txt

? FOLDER_ADD = mnu.flyout.add
= fnc.fld.search
= fnc.doc.add
= fnc.mat.add
= fnc.add.with.search.help(MAT1_ESH_TREX_BASIC)
...

If you like to have a hot key, you can add it like this in the menu.guidef:

fnc.add.with.search.help(MAT1_ESH_TREX_BASIC).keystroke = control L



Restart ECTR, upload the settings and click the new button:

Search for something:

Find something:


Using the search help in a quick search

(info) Search helps that require default values (like MAT1_ESH_TREX_BASIC) are only supported as of 5.2.5.1.

default.txt
# Define new SearchHelp provider type
plm.search.provider.MATEXT = SH_PROVIDER(MAT1_ESH_TREX_BASIC,S/RP/SEARCH_TERM)

# Add new SearchHelp provider to UI
plm.search.provider.types = @plm.search.provider.types@;MATEXT



Related SAP Notes/KBAs


__________________________________________________________________________________________________________