Dear SAP Community Member,
In order to fully benefit from what the SAP Community has to offer, please register at:
Thank you,
The SAP Community team.
Skip to end of metadata
Go to start of metadata


The aim of this document is to provide an operations guide for the day-to-day work with Enterprise Search within CRM. It is focused on CRM templates delivered by SAP.

Release Relevance

This guide is valid for release SAP CRM 7.0 SP02 and later. It will be available for customers at the SAP Solution Manager (System SL2) under SAP CRM 7.0 -> Basic Settings for SAP CRM -> UI Framework and Configuration -> Enterprise Search Integration -> Tab Configuration and in SAP Service Marketplace via SAP CRM 7.0 -> Operate -> Configuring CRM Enterprise Search 7.0.pdf.

New from SAP WEBCUIF 7.0 EhP1 on

  • Real-Time Indexing (from SAP WEBCUIF 7.0 Ehp1 on)
  • Check Real-Time Indexing (from SAP WEBCUIF 7.0 Ehp1 on)

How to Use

How to Use at SAP

Installing TREX for Embedded Search

For installing TREX for Embedded Search and the right TREX version see Note 1249465: TREX 7.1: Installing TREX for Embedded Search.

Connecting a CRM System to Enterprise Search

The CRM customizing has been enhanced by sub-menu Enterprise Search Integration. It groups together all Enterprise Search related customizing so that the administrator can configure CRM for ES. It can be reached via following path: Customer Relationship Management -> UI Framework -> Enterprise Search Integration

  1. Configuring TREX Connection for Enterprise Search If the connection has already been created, you simply specify it in the input field and press the 'Execute' button. If it does not exist yet you must log onto the TREX Administration UI and carry out the following tasks: - Create a connection to your backend system - Specify the system name, system number, application server, default client, TREX user and password. - Create an RFC destination to your backend system - Specify the RFC destination name.
  2. Configuring Parameters for Initial Extraction
  3. Configuring Client for Template Modeling
  4. Configuring Software Component for Template Transfer

For further details select the item and press F1.

If only search enablement is required then only steps 1 and 2 are required. If, on the other hand, templates are to be modeled as well all 4 steps need to be carried out.

Initial Extraction

After having configured the system for Enterprise Search the data have to be extracted to Enterprise Search. There are two ways of doing this:

Extracting Data of All Templates

This is only feasible if the data volume is small. Nevertheless it can take several hours until all data are extracted. For this purpose execute program ESH_ADM_INDEX_ALL_SC in the background. Create variant ES_INDEX_RUN with following parameters:



Delete All Search Connectors


Create All Search Connectors




Schedule Initial Indexing


The job creates a separate extraction job for every template. If initial extraction takes, say, longer than a day to complete, you should consider scheduling initial extraction for each template in separate, see below.

For SAP WEBCUIF/CRM 7.0: Please note that if no connector has been created beforehand, the job will not execute successfully. For further details refer to Note 1278561.

From SAP WEBCUIF 7.0 EhP1 the report ESH_ADM_INDEX_ALL_SC also contains a flag to start real-time indexing.

Extracting Data of a Specific Template

Logon to the Enterprise Search Administration Cockpit of the CRM system. You can reach it from the CRM SAP Easy Access menu by following path: SAP menuArchitecture and Technology → Enterprise Search IntegrationToolsES Administration Cockpit Alternatively you can call transaction ESH_COCKPIT. You require authorization SAP_ESH_LOCAL_ADMIN. Carry out the following actions:

  • Select the template to be extracted.
  • Select option ActionsSchedule Indexing

Delta Extraction

Delta Extraction (for SAP WEBCUIF 7.0)

After initial extraction was completed delta extraction has to be scheduled so that changes to CRM objects are reflected in Enterprise Search. We do not recommend scheduling delta indexing for all CRM templates from the ES Administration Cockpit as every template is processed in a separate background process. The reason is that batch processes may become completely blocked by Enterprise Search processes. Instead program ESH_IX_PROCESS_CHANGE_POINTERS should be used. It processes all templates in one Logical Unit of Work (LUW) and thus occupies one batch process at the most. Create a variant with an appropriate name, e.g. RUN_EVERY_MIN, or RUN_EVERY_5MIN, reflecting the period of delta extraction. For variant RUN_EVERY_MIN specify following parameters:





Delay [seconds]


Exit processing after [hours]


Reschedule automatically


Process in background




Real-Time Indexing (from SAP WEBCUIF 7.0 Ehp1 on)  

From SAP WEBCUIF 7.0 Ehp1 on the Real-Time Indexing from Netweaver replaces the report ESH_IX_PROCESS_CHANGE_POINTERS. Real-Time Indexing is configured via the Admin Cockpit.

Technical Monitoring

Carry out the following actions:

Check Enterprise Search Cockpit

Logon to the Enterprise Search Administration and check that all connectors are active. Specifically check that no connectors are in status 'error'. If errors occurred click on tab 'Job Log' for further details.

Check for Short Dumps

Logon to the CRM system and call transaction ST22. Check if there are any short dumps related to Enterprise Search.

Check That All Templates Can Be Searched

Execute program ZESH_CHECK_ACTIVE_OBJECTS. This program is only internally available in SAP CRM 7.0 systems.

From SAP CRM 7.0 EhP1 report CRM_ESH_CHECK_ACTIVE_OBJECTS can be used for that purpose.

Check Delta Indexing

Check Delta Indexing Job (for SAP WEBCUIF 7.0)

Check status of job ESH_IX_PROCESS_CHANGE_POINTERS in SM37. Check the application log for delta indexing under object CRM_ES and sub-object CRM_ES_DELTA_EXTR.

Check Real-Time Indexing (from SAP WEBCUIF 7.0 Ehp1 on)  

Via System Settings -> Control Real-Time Indexing the connectors can be viewed which are activated for Real-Time Indexing.

Check Initial Indexing Jobs

The Job ESH_ADM_INDEX_ALL_SC spans as many separate jobs as there are templates. Check the application log under object CRM_ES and sub-object CRM_ES_DATA_EXTR.

Each job executes program ESH_IX_CRT_INDEX_OBJECT_TYPE with a variant holding the execution parameters - among others the template id is stored. To look at them call transaction SE38 for program ESH_IX_CRT_INDEX_OBJECT_TYPE, press button 'Variants' and specify the variant number from the job log.

Keep in mind that even if the initial indexing may have been flagged as successful, there could still have been dumps generated. Therefore it is important that you scan for errors in the dumps database.

Should you encounter exception CX_ESH_IF_NOT_SUPPORTED w.r.t. One Order authorization templates such as CRM_ACE2_BP_UCT, CRM_ACE2_LC_UCT, CRM_ACE2_LC_AC, CRM_ACE2_PR_UCT, CRM_ACE2_BP_ACL, CRM_ACE2_PR_ACL, CRM_ACE2_OO_ACL, CRM_ACE2_OO_UCT, CRM_ACE_USER_OTS it might be that you will have to activate the corresponding extraction BAdI (definition: BADI_ESH_IF_OBJECT_DATA, implementation: CRM_ESH_1O_AUTHORITY) by hand.