Guide for Enterprise Search in Enterprise Asset Management (EAM)

EAM Enterprise Search Guide Enterprise Asset Management Document Version: 1.0 – 2016-06-14

Guide for Enterprise Search in Enterprise Asset Management (EAM) SAP Enterprise Search on HANA

CUSTOMER

Document History

Version

Date

Change

1.0

2016-06-14

First officially released version via SCN

CUSTOMER

2

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Guide for Enterprise Search in Enterprise Asset Management (EAM)

Document History

Document History

Version

Date

Change

1.0

2016-06-14

First officially released version via SCN

CUSTOMER

2



Document History

Table of Contents

1

Introduction ..................................................................... .............................................................. 5

2 2.1 2.2

Overview of Ente rprise Search Result ........................................................... ........................................................................................ ............................. 6 Example 1: SAP Enterprise Search on HANA ............................................ ................................. ......... 6 Example 2: TREX Search............................ ................................. ................................. ......................... 7

3 3.1

Getting Started with SAP Enterprise Search .......................................................... ................ 10 System Landscape Landscape Variants ................................. ................................. ................................. ............ 10 3.1.1 SAP HANA-Based Variant .................................................................................................. 10 3.1.2 TREX/BWA-Based Variant.............................. ................................. ................................. .. 11 11

4 4.1 4.2 4.3

Search Customizing in General ................................................................................................. 13 Check Search Connection................................ ................................ ................................. .................. 13 Activating Interactive Navigation ....................................................................................................... 14 Search Log Customizing ..................................................................................................................... 14

5 5.1

Enterprise Search i n EAM ........................................................... ........................................................................................................... ................................................ 16 EAM Search Models Depending Depending on Connection Type .................................................... .................. 16 5.1.1 ERP (EHP6, EHP7) and TREX Connection ................................ ................................ ........ 16 5.1.2 ERP (EHP7 SP11, EHP8 SP02 or newer) and TREX Connection .............................. ....... 17 5.1.3 ERP on HANA or S/4 HANA with HANA DB Connection ............................... .................. 18 Input Help for EAM Applications ........................................................................................................ 18 5.2.1 New Input Help UI for EAM Web Dynpro Apps ............................................... .................. 19 5.2.2 Personalization Personalization of the Input Help ............................... ................................. ....................... 21 5.2.3 Customizing View "Activate Enterprise Search for the Input Help" ............................... 22 Categories in EAM................................................................................................................................ 24 Managing Cross-Model Cross-Model Attributes .................................................. ................................. .................. 27 Searches in EAM based on Enterprise Search Models ............................ ................................. ....... 28 5.5.1 Structure List for Technical Objects................................ ................................ .................. 28 5.5.2 Input Help in SAPGUI .................................................. ................................. ....................... 29

5.2

5.3 5.4 5.5

6 6.1

6.3

Configuration and Administration Tools ....................................................... .................................................................................. ........................... 32 Using the Connector Administration Administration Cockpit ...................... ................................ ............................. 32 6.1.1 Creating and Indexing a Connector ................................ ................................. .................. 33 6.1.2 Connector Details............................. ................................. ................................ .................. 35 6.1.3 Real-Time Indexing.............................................................................................................. 35 6.1.4 Link Navigation Depending on UI Technology ........................................................... ....... 38 Using the Search and Analytics Modeler .............................. ................................ ............................. 39 39 6.2.1 Creating or Extending Search and Analysis Models ..... ................................. .................. 39 6.2.2 Transport of Model Corrections Corrections .......... ................................. ................................. ............ 44 Using Task Lists to Create and Index Connectors .......................................................... .................. 44

7 7.1

Additional Documentation ........................................................................................................ 46 NetWeaver NetWeaver 7.3 and Older ...................... ................................. ................................ ............................. 46

6.2


Table of Contents

CUSTOMER © 2016 SAP SE or an SAP affiliate company. All rights reserved.

3

7.2 7.3 7.4 7.5

Official Road Map................................ ................................ ................................ ................................. 46 SAP Notes ............................................................................................................................................ 46 SCN Blogs ............................................................................................................................................ 47 Guides and Wiki Links ......................................................................................................................... 47

7.6 7.7

Components for Incidents BC-EIM-ESH, PM-ESH ................................ ................................ ........... 47 Transaction Codes Codes and Reports for ES ....................................... ................................ ...................... 47

Abbreviations EAM

Enterprise Asset Management Management

PM

Plant Maintenance

UI

User Interface

ES

Enterprise Search

SCN

SAP Community Network (scn.sap.com)

BWA

SAP Business Warehouse Accelerator

EHP

Enhancement Package

SP

Support Package

PFCG

Profile Generator (Transaction PFCG)

UIBB

User Interface Building Block (part of Web Dynpro Screen)

AS

Application Server

TREX

Search and Classification Classification Engine

SWC

Software Component

DDIC

Data Dictionary

CUSTOMER

4



Table of Contents

1

Introduction

SAP provides you with a powerful, fast and complete search tool to be used during the daily work in Plant Maintenance (PM). The Enterprise Search (ES) reduces the time spent searching as you no longer have to navigate to different transactions, transactions, applications and tab pages to find the object you wish to edit. This guide deals with the Enterprise Search in general and its use in Enterprise Asset Management (EAM). It does not explain all the features of the Enterprise Search that are available as these are explained in the SAP Library. Nevertheless, links to the most important ES documentation documentation are provided here. SAP Innovation Discovery, Discovery , which is accessible with a valid S-User, provides you with a rough overview of the EAM functionality described in this guide. As Line of Business choose Business choose Asset Asset Management and Management and as Product Product choose choose Enterprise Management. You can further drill down to the Software Product Version. Version .

The search model in EAM objects was completely reworked and an own result UI was delivered with ERP release EHP7 SP11/ EHP8 SP02. The current SAP NetWeaver release for screen shots and links to other documentation of version 1.0 of this guide is 7.4.


Introduction


5

2

Overview of Enterprise Search Result

2.1

Example 1: SAP Enterprise Search on HANA

In this example, you are searching for an equipment manufactured by Strobel. We assume that you are using a S4/HANA System and you are logged on via a Fiori Launchpad on the frontend system. The screen offers a search functionality indicated by a magnifying glass in the upper right-hand corner (1). When you click on the search button, an entry field (2) for search terms appears. To narrow down the search results, you first select a search category (3) from the dropdown list (4), which lists all the valid search connectors. If you do not choose any restriction, the system searches all the data. In our example you choose Equipments (5).

Next, you enter the search string Strobel and receive a search result containing 336 pieces of equipment. The system provides the most important information in up to nine fields of the technical object master record for all the pieces of equipment listed in the Result List. If the search string isn’t included in one of the nine fields, the system adds an extra line with the field name and value that matches the search string. In addition, the search string is highlighted. If you want to increase the number of results displayed on one screen, you can hide the additional technical object information by clicking on the arrow in the lower right-hand corner of each result entry. The result list can be displayed as a table and the results can be sorted with the icons in the upper right-hand corner above the list. On the left side of the screen you can drill down and filter the results. If y ou search for pieces of equipment, filters such as Type of Technical Object, Planner Group, Location and Work Center are available. You can add more filter options by choosing the pushbutton Show All Filters.

CUSTOMER

6




2.2

Example 2: TREX Search

As a maintenance planner you might use the Order and Notification Information Center of PFCG-role SAP_COCKPIT_EAMS_GENERIC_FUNC2 of Enterprise Asset Management in Web Dynpro. You can enter a search term in the Search. The system searches in all the categories provided (here in Maintenance Orders and Maintenance Notifications) irrespectively of the field where this value is stored. In this example the search string is eamt.




7

The system then provides a result list and shows the number of objects matching the search string in the upper right-hand corner. In our example, 11.923 orders or notifications contain the search string eamt. In the screen area on the left-hand side you can determine in which type of data the search sh ould be performed. After you have chosen the type of data (in this example order or notification), additional specific filter criteria are available to narrow down the number of results even further.

You can now choose Maintenance Notifications and narrow down the results to 733 matches. You have the option of setting additional filters, such as the Notification Type or the Maintenance Work Center, in the screen area on the left-hand side. Beneath the data type (e.g. Notification Type), the system lists the field values (e.g. M3, M2, M1) and, in brackets, the number of objects that match the search term. In the Result List, the following key features are available for each result entry: 

In the upper left-hand corner of the result entry, the system displays an icon that represents the data type. This allows you to easily distinguish between data types.

CUSTOMER

8










The first line of a result entry always shows the document number as a clickable link. This enables you to easily navigate to the object that is then displayed in a separate window. You can display up to nine fields of the s elected document. The first value, which corresponds to the search term, is highlighted in bold letters. There are links at the end of each result entry. These links enable you to navigate to further information (e.g. Details, Notification Items…) or to navigation targets where you can proceed with your work ( Add to Favorites, Display Notification in Asset Viewer …).

The picture shows a search result list on the SAP Web UI for Plant Maintenance. You can call this search solution irrespectively of the EAM role by using the corresponding SAPGUI transaction ESH_SEARCH.




9

3

Getting Started with SAP Enterprise Search

3.1

System Landscape Variants

As shown in the preceding chapter, two variants of the SAP Enterprise Search solution exist. On the one hand, there is the SAP HANA-based variant, which provides direct search access to business data stored in SAP HANA tables. On the other hand, the TREX/BWA-based variant, which requires an additional search technology such as TREX (Search and Classification Engine) or BWA (SAP Business Warehouse Accelerator).

3.1.1

SAP HANA-Based Variant

The picture below illustrates the process flows for the SAP HANA-based variant at runtime (AS ABAP = Application Server ABAP):

CUSTOMER

10




Runtime: A search application (for example, based on the standard user interface) in the SAP system sends a search request to SAP Enterprise Search, which translates the request into SQL-SELECT statements and directs them to SAP HANA. The search result calculated by SAP HANA is transferred to SAP Enterprise Search. It sends the search result back to the search application. For getting an overview about Embedded Search in general, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as the release. Under Application Help, choose Function-Oriented View Search and Operational Analytics Embedded Search. →

→

Note: Before SAP NetWeaver 7.5 Support Package Stack 01 the SAP Enterprise Search on HANA (short form: Enterprise Search) was called Embedded Search.

3.1.2

TREX/BWA-Based Variant

The picture below illustrates the process flows for TREX/BWA-based variant at the indexing time and runtime.

Indexing time: At scheduled times SAP Enterprise Search checks for changes to the SAP system data that can be indexed. The changes to the data are extracted and passed to Search and Classification (TREX) or SAP Business Warehouse Accelerator, where they are added to the search index. Runtime: A search application in the SAP system sends a search query to SAP Enterprise Search. This forwards the query to Search and Classification (TREX) or SAP Business Warehouse Accelerator, which uses search indexes to form a search result and passes this result to SAP Enterprise Search. It sends the search result back to the search application.




11

For more information about the TREX variant, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as the release. Under Application Help, choose Function-Oriented View Search and Operational Analytics Other Search Technologies Search and →

→

→

Classification TREX. Versions 7.0 and 7.1 of TREX with information on architecture, configuration and administration can be found here.

CUSTOMER

12




4

Search Customizing in General

The IMG node Search and Operational Analytics can be easily reached by typing ESH_IMG in the transaction field of the SAPGUI. Here you can make all the required Customizing settings for the search. The Customizing steps are described in the document at the front of each single Customizing step.

4.1

Check Search Connection

First of all, check Customizing to establish which kind of models you can use for searches. Open the SAP Reference IMG (transaction SPRO) and choose SAP NetWeaver Search und Operational Analytics Common Settings for Operational Analytics and E nterprise Search Configure Indexing Set TREX/BWA Destination or SAP HANA DB Connection. →

→

→

→



If Use TREX (1) is selected, then an RFC connection is established to the TREX server.



If Use SAP HANA Secondary DB Connection (2) is selected, the system is built on a SAP HANA database.




13

For more information about Setting Up Embedded Search, see SAP Library under Technology Platform SAP NetWeaver 7.4. Under Application Help, choose Function-Oriented View Search and Operational Analytics Embedded Search. →

→

4.2

→

→

Activating Interactive Navigation

You have to activate the option of filtering the search results with interactive navigation. You can do this in Customizing for SAP NetWeaver under Search and Operational Analytics Enterprise Search Search Configuration Set Parameters for Federated Search. To enable interactive navigation in all result lists (not only for EAM objects), select the Interactive Nav. checkbox. Alternatively, you can open the Customizing view →

→

→

ESH_CU_FED in transaction SM30.

4.3

Search Log Customizing

You can define settings for the log that is written when queries are performed in Customizing for SAP NetWeaver under Search and Operational Analytics Enterprise Search Search Configuration Configure Query Logging (transaction ESH_QL_CUST). For details, refer to the IMG documentation of the Customizing node. →

→

→

The logs can be examined in the Enterprise Search Query Log (transaction ESH_QUERY_LOG). Make sure that you adhere to the Data Protection Act and the security standards within your company and keep in mind that a too detailed tracing of queries can have an impact on the system performance. For more details, read the program documentation. For more information about traces and logging of Enterprise Search, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as the release. Under Application Help, choose Function-Oriented View Search and Operational Analytics Managing Search and Operational Analytics Technical Operations Manual Monitoring Trace and Log Files. →

→

CUSTOMER

14


→

→

→



For more information about security, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as the release. Under Application Help, choose Function-Oriented View Search and Operational Analytics Security Guide for Search and Operational Analytics Security of Logs and Traces. →

→

→




15

5

Enterprise Search in EAM

5.1

EAM Search Models Depending on Connection Type

A search model is a combination of attribute views and search rules for a business entity. SAP delivers search object connector models for business objects such as maintenance orders or functional locations. If these models do not meet your requirements, you can create new models or copy and change existing ones. The segments of a search model are structured by nodes. You can use existing nodes or create new nodes by importing a data source and assign node names and attributes. In a next step, you arrange the nodes in a hierarchical structure by defining relations between the nodes, either as a composition within the search object connector model or as an association to other models in the same software component. To use the search models, you have to create search object connectors (instances of these models) which index the data for searching and provide the search access to specific search object types at a specific destination. Three different groups of search models exist for Enterprise Search on EAM Objects. EAM-specific search models were first delivered with the first EAM Web Dynpro Applications (see 5.1.1). The new EAM input help then offered reworked models (see 5.1.2) and for S/4HANA and ERP on HANA, new models were created based on HANA technology (see 5.1.3).

5.1.1

ERP (EHP6, EHP7) and TREX Connection

You use the EAMS virtual models (based on SAP-APPL application models) in search software component EA-APPL if the following prerequisites are fulfilled: 

SAP enhancement package 6 or 7 (SP lower than 11) for SAP ERP 6.0



TREX connection



Business function LOG_EAM_SIMPLICITY (switch EAM_SFWS_EAMS_EA) is activated

Model Name

Model Description

EAMS_BUS0010

Functional Location

EAMS_BUS0019

Task List for General Maintenance

EAMS_BUS0019_EQ

Task List for Equipment

EAMS_BUS0019_FL

Task List for Functional Location

EAMS_BUS1020

Maintenance Plan

EAMS_BUS2007

Maintenance Order

EAMS_BUS2038

Maintenance Notification

EAMS_BUS2092

Measurement Document

EAMS_CONFIRMATION_PM

Completion Confirmation

EAMS_DOCUM_INFO_REC

Document Info Record

CUSTOMER

16




EAMS_EQUI

Equipment

EAMS_MAINTITEM

Maintenance Item

EAMS_MATERIAL

Material

EAMS_MEASURINGPOINT

Measuring Point / Counter

EAMS_OBJECTLINK

Object Link

EAMS_PURCHORD

Purchase Order

EAMS_PURCHREQ

Purchase Requisition

5.1.2

ERP (EHP7 SP11, EHP8 SP02 or newer) and TREX Connection

With SAP enhancement package 7 (SP11) the new input help for EAM Web Dynpro applications was introduced and, with respect to that, the search models for EAM were completely reworked. You use the search models in search software component SAP_APPL under PM if the following prerequisites are fulfilled: 



SAP enhancement package 7 (SP 11) or SAP enhancement package 8 (SP 02) for SAP ERP 6.0 For EHP 7 (SP11), the improvements are delivered with SAP Notes 2257725 and 2257729. For EHP8 (SP02), the improvements are delivered with SAP Notes 2257725 and 2293084. TREX connection

Note: if these prerequisites are fulfilled, the EAMS models listed in section 5.1.1 are obsolete and only the models in the search software component SAP_APPL need to be scheduled. Model Name

Model Description

BUS0010

Functional Location

BUS0019

Task List for General Maintenance

BUS0019_EQ

Task List for Equipment

BUS0019_FL

Task List for Functional Location

BUS1020

Maintenance Plan

BUS2007

Maintenance Order

BUS2038


BUS2092


CONFIRMATION_PM


EQUI

Equipment

MAINTENANCEITEM

Maintenance Item

MEASURING_POINT


OBJECT_LINK

Object Link




17

5.1.3

ERP on HANA or S/4 HANA with HANA DB Connection

The search models for the HANA database can be found in software component SAPAPPLH under PM. They are switched with switch BSESH_HANA_SEARCH_ECC: Model Name

Model Description

CONFIRMATION_PM_H


EQUIPMENT_H

Equipment

FUNCT_LOCATION_H

Functional Location

MAINTENANCE_ORDER_H

Maintenance Order

MAINTENANCE_PLAN_H

Maintenance Plan

MAINTENANC_PL_IT_H

Maintenance Plan Item

MAINT_NOTIFIC_H


MAINT_TASK_LIST_H

Task List

MEASUREMENT_DOC_H


MEASURING_POINT_H


OBJECT_LINK_H

Object Link

5.2

Input Help for EAM Applications

You intend to use the new input help for EAM objects such as technical objects, maintenance orders and notifications or task lists. If you have a S4/HANA system and want to access the EAM applications as tiles on the Fiori Launchpad, you first have to assign the corresponding business roles for the maintenance planner (SAP_BR_MAINTENANCE_PLANNER) or for the maintenance technician ( SAP_BR_MAINTENANCE_TECHNICIAN).

The picture below shows the Fiori Launchpad for the maintenance planner with several groups of tiles. Each tile represents an EAM app. In this example, you choose the app for displaying maintenance notifications (2) from the group EAM-Notification (1).

CUSTOMER

18




In the Display Maintenance Notification app, you type in the notification number to view the respective document or you use the input help to search for a notification.

5.2.1

New Input Help UI for EAM Web Dynpro Apps

The picture below shows the search results of the input help for the Display Maintenance Notification app if you have activated the Enterprise Search. In the header area of the Search: Notification popup, you can enter a text string in the free text search (1) or use specific search criteria for a number of fields (2). You can save a search as Favorite (3) or choose an existing search instead of entering the criteria anew every time. If you do not choose any search criteria, the system provides a complete list of all notifications. On the left-hand side, you can filter the results with Interactive Navigation (see 4.2). To copy the notification number to the app, choose the arrow icon (5) to the left of the appropriate result number.




19

For each search result, the system provides a summary with up to nine field values of the document (1) and several links for gathering more information. When you c hoose Details, a panel providing further field values opens on the right-hand side of the screen (3). The little red sign (2) indicates the search result that is currently being displayed in the Details panel. Additionally, you can use the links (4) to open the document in Asset Viewer or to add it to your favorites in the EAM Information Cockpit.

CUSTOMER

20




This example is taken from an S4/HANA system with a HANA database, the corresponding connector for the notification search is MAINT_NOTIFIC_H, see 5.1.3. For general information about EAM Enterprise Search, see Searching with SAP NetWeaver Enterprise Search in SAP Library.

5.2.2

Personalization of the Input Help

If you often execute the search based on the same criteria, you can save your search cr iteria as favorites. You enter the search c riteria, choose Save Favorite, and assign a name to your favorite search. While working with the Enterprise Search, you can then select one of your favorite searches so that the system executes the search with the respective search criteria.




21

For each application, you can also define that one favorite search is always executed when you open the input help for that application. In this example, you want the notification result list to be restricted to notification type UA and planner group W01. To specify that these search criteria apply by default each time you open the input help for the notification, you save the search as a favorite for your user by typing your user name in capital letters. This search is then automatically executed whenever you open the input help for the notification.

5.2.3

Customizing View "Activate Enterprise Search for the Input Help"

Before you can use the Enterprise Search as input help for EAM objects, you have to activate the Enterprise Search in Customizing for Plant Maintenance and Customer Service under Maintenance Roles Maintenance →

Worker

Activate Enterprise Search for the Input Help or in View Maintenance (transaction SM30, view V_EAMS_ESH_CAT). You can specify for a combination of field name and search category in EAM whether you want to use the Enterprise Search when you open the input help for a specific field on the SAP Web UI. The first column contains the technical name of the field and the second column shows the search category. In this →

CUSTOMER

22




example, the Activate checkbox is selected for all fields, so the Enterprise Search is available as input help in EAM Web Dynpro applications for the fields with the same technical field name as in the first column of the view.

Hint: You have the option of defining customer-specific search helps for Web Dynpro fields in Customizing under Plant Maintenance and Customer Service Maintenance Roles Maintenance Worker Configure Search Help Assignment (view V_EAMSC_UI_SHLP). If an entry exists for any of these fields with a different search help, the Enterprise Search will not show up, even if it is activated. →

→

→

By default, the Enterprise Search is not selected in the Customizing activity. If you do not activate the Enterprise Search as input help or if the c orresponding connector is not running properly, the simple search opens for the input help. The picture below shows the search screen of the simple search.




23

5.3

Categories in EAM

Search categories allow users to narrow down their search and filter search results. You can assign both search models and connectors to specific search c ategories. By default, a connector inherits the categories from its model. You can create a search category for a single connector (e.g. EAM_JOB) or group different connectors together into one search category (e.g. EAM_OBJECTS). You create or delete search categories in the modeler when creating models or also in the Administration Cockpit, (see 6.1). When you have created search categories, these categories are displayed beside the All Objects entry. They allow you to enter a search term and only execute the search in a specific category, such as Confirmations or Jobs. If you select a category, the search is executed with all the connectors belonging to this category. The picture below shows the search categories in the Search section of the Master Data Information Center. If you open the More menu, you can also choose EAM Objects and execute your search in the EAM_OBJECTS category. This category groups together all the EAM connectors.

CUSTOMER

24




You can view the c ategory that is assigned to a specific Web Dynpro application in a specific PFCG-role. In the role SAP_COCKPIT_EAMS_MAINT_WORKER2 for the maintenance worker, for example, you choose the Menu tab page and open the context menu of the Master Data Information Center by clicking the r ight mouse button. You choose Details and see that the category EAM_OBJECTS is assigned as search category to the Master Data Information Center. So the maintenance worker can use all search categories grouped together in the EAM_OBJECTS category when he searches for EAM documents in the Master Data Information Center.

The SAP search models are normally delivered without any specification of categories. In EAM, search categories have been defined for all models. In the Administration Cockpit (see 6.1), you can find the categories in the details




25

of the respective connector, on tab page Categories. Four categories are assigned to the connector EQUIPMENT_H. In the Administration Cockpit, additional categories can be added. These category assignments are not transportable.

If you choose Maintain Categories, the hierarchy of categories is visible and editable. The value ( EAM_OBJECTS) of parameter SEARCH_CATEGORY of the PFCG-role shown in the Display Roles picture above is a collection of several single categories.

CUSTOMER

26




You can specify your own customer-specific categories and relations in the popup. For more information about Managing Search Categories , see SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as the release. Under Application Help, choose Function-Oriented View Search and Operational Analytics Managing Search and Operational Analytics Search-Specific Administration Tasks and Information. →

→

→

Information about categories is also stored in the search model. When a connector is created, the connector inherits the categories from its model. See section 6.2 for maintenance of categories in the search model. See also SAP note 2274409 - Creation of Categories for Enterprise Search in EAM: Search Models and Connectors with an example from the EAM area.

5.4

Managing Cross-Model Attributes

If there are attributes in various models with values that have the same meaning and common analysis is possible, you can group these values in a cr oss-model attribute. This allows you to search for attributes across several connectors or use a specific attribute to refine search results. Cross-model attributes are independent of software components. Any changes made to a cross-model attribute therefore immediately affect all models that are assigned to this attribute. You process cross-model attributes in the ESH Modeler (see 6.2.1 by selecting a search model and carrying out step 4 (Model Requests) of the guided activity. On the Request Attributes tab page, you can add, remove, and maintain cross-model attributes in the lower right-hand screen area Assigned Common Attributes.

The procedure is explained step by step in chapter Managing Cross-Model Attributes of SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as




27

the release. Under Application Help, choose Function-Oriented View Search and Operational Analytics Managing Search and Operational Analytics Search-Specific Administration Tasks and Information. →

→

→

5.5

Searches in EAM based on Enterprise Search Models

The Enterprise Search models are also used in the structure list for searching for technical objects in EAM and in DDIC input helps for SAPGUI transactions, to name just two examples.

5.5.1

Structure List for Technical Objects

The structure list for technical objects was originally based on the DDIC search help EAMS_SHLP_ELM_TO_ES. If you have activated the business function Simplified Management of EAM Functions 3 (LOG_EAM_SIMPLICITY_3), the system shows a second tab page in the input help of the technical object. On this Structure List tab page, the system displays a hierarchical structure of the technical object and its assigned materials, and provides you with essential information on the technical objects and their c omponents in a tree table. You can also use the SAP Enterprise Search in the input help of technical objects if you activate the SAP Enterprise search in Customizing for the technical object field EAMS_TEC_OBJ_NO with category EAM_TECHOBJ (see 5.2.3). If you activate both, the structure list with business function LOG_EAM_SIMPLICITY_3 and the SAP Enterprise Search in Customizing, you can use the combined search in the input help for technical objects in the following business objects: 





Maintenance Order: o

Initial screen

o

Header level (tab General Data)

o

Operation List

o

Operation Details

Maintenance Task List: o

Initial screen (for technical object task lists)

o

Operation List

o

Operation Details

Maintenance Notification: o



Header level (tab General Data)

Maintenance Plan: o

Item List

In the example below, you want to cr eate a maintenance order and you have already specified a technical object in the corresponding field. Now you open the input help to view the assigned materials and navigate to superior levels in the structure list. You can insert any technical object from the list into the Technical Object field by selecting it and choosing OK, which also closes the popup.

CUSTOMER

28




For more information about the structure list in the input help of technical objects, see Selection of Technical Objects from the Structure List in SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/pcat_erp. Choose SAP ERP Application Help SAP Library SAP ERP Central Component Logistics Plant Maintenance (PM) SAP Web User Interface for Plant Maintenance (PM) . →

→

→

→

→

→

The connectors with category EAM_TECHOBJ are used to find the objects that are displayed in the structure list.

5.5.2

Input Help in SAPGUI

There are several DDIC search helps for SAPGUI transactions that are based on Enterprise Search models. The collective input help offers additional search helps if the connector is running. In the transaction Display Equipment (IE03), for example, both a simple search as well as an advanced search based on Enterprise Search are available.




29

If the connector is not active, these menu entries are not shown in the list for searches. In the ABAP Dictionary (transaction SE11) you can check which connector the search uses. The search help EQUI_ES provides these two search helps as a part of the collective search help assigned to the Equipment field.

To figure out which search connector the search is based on, you can display a search help in ABAP Dictionary (SE11). In the Search help parameter list, the corresponding search connector is displayed as the Default value of the parameter OBJECT_TYPE_ID. In this example, the default value is EQUI'. This means the Advanced Search for Equipment (Enterprise Search) appears as the input help for the Equipment field when the connector EQUI is running. ‘

CUSTOMER

30




If you have created your own search helps or search models that you want the search helps to use, make sure that you have adapted the name of the search connector. In S4/HANA systems, the HANA connectors are used by the search helps (in our example, EQUIPMENT_H instead of EQUI, refer to the table in chapter 5.1.3).




31

6

Configuration and Administration Tools

To be able to work with the Enterprise Search, you should be familiar with the Connector Administration Cockpit and the Search and Analytics Modeler for search models. This chapter does not focus on the correct set-up and daily administration of the Enterprise Search, but rather on how you as a very experienced user or consultant can check the search model and connector status. For information about the necessary administration tasks, see Managing Search and Operational Analytics in SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as the release. Under Application Help, choose Function Oriented View Search and Operational Analytics. →

6.1

Using the Connector Administration Cockpit

The following pages are intended to give you an introduction to the Administration Cockpit. You can find the official, detailed documentation about the Administration Cockpit in the SAP Library. You can work in the Administration Cockpit if the cockpit role SAP_ESH_ADMIN is assigned to you. You open the cockpit in a browser window via transaction ESH_COCKPIT. On the initial page, you can check if the search connectors are running and correctly indexed. In the example below, the red box (1) shows two connectors for pieces of equipment and functional locations (technical names: EQUI and BUS0010). Both connectors are set up correctly because their status is Active, they have a number of entries and are activated for the search (the checkbox in the Search column is selected, (2)). Additionally, the checkbox in the Modified column is selected, which indicates that a newer version of the search model exists on which the connector is based. To update the current connector version, select the corresponding table entry, choose Actions (3) and select Update in the dropdown menu. To take a closer look at the connector models, you can navigate to the Modeler for Search and Analytics by using the Modeler link (4).

CUSTOMER

32




Every time the cockpit is opened, a background job looks for changes made to the models in client 000. The connectors are locked until this job is finished. In the job overview (transaction SM37), you can check when this job (ESH_IEF_IMP_OM_UPDATE_CONTENT) is finished.

6.1.1

Creating and Indexing a Connector

In the following example, the connector CONFIRMATION_PM_H is not running in the system. It therefore can't be found in the cockpit list. To (re-)create connectors, choose Create.

First select the corresponding software component in the popup (here SAPAPPLH). The system lists all search models of the selected software component. Models that are already running are grayed out so that connectors for these models cannot be created. Choose one or more search models for which you want to re-create connectors and choose Create Connector (1).

The popup closes and you go back to the cockpit. The system provides a messages that the connector will be created. Initially, the search connector has the status New.




33

The connector status changes to Preparing (1), when you Refresh (2) the list of connectors. You can also filter the list according to the connector status (3).

When you create a connector, the dependent connectors are also created if they're not available yet. If an error occurs while creating a connector and the status is Error While Preparing or Error While Indexing, you should restart the step where the creation stopped. In this example, the indexing preparation is repeated for connector EQUIPMENT_H.

CUSTOMER

34




6.1.2

Connector Details

When you select a connector in the Administration Cockpit, you can see more connector details at the bottom of the screen. You can find general information about the connector such as status, software component, or model name on the General tab. On the Job Log tab, you can check the messages of the last job run. On the Categories tab, you can see if categories are already available or you can maintain them. For more details, see chapter 5.3 Categories in EAM.

6.1.3

Real-Time Indexing

To make the objects in the connectors available in the search, you have to start or schedule indexing for connectors in the following cases: 

In the SAP HANA-based variant: You are using connectors that do not provide database support.



In the TREX/BWA-based variant: You have to start or schedule indexing for all connectors.




35

In these cases, indexing runs either as full indexing or as delta indexing. The real-time indexing ensures that a new data record is immediately added to the respective index. For more information about Controlling Real-Time Indexing , see SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. Choose SAP NetWeaver 7.4 as the release. Under Application Help, choose Function Oriented View

Search and Operational Analytics

→

Managing Search and Operational Analytics.

→

The indexing job must run properly and can be started and stopped in the Administration Cockpit manually by selecting System Settings Control Real-Time Indexing. →

While creating a search connector, you can choose whether or not you want real-time indexing for the connector.

CUSTOMER

36




If a connector is selected for Schedule Indexing (1), the system lists all dependent connectors in a popup. To copy scheduling parameters such as the Start Immediately or Real-Time Indexing (3) to all of them, you can open an Input Form (2). For some connectors it is not possible to choose real-time indexing, in this case the field is grayed out.

In the Input Form, you can choose the parameters you want to copy and then select the connectors (2). Choose Copy Settings (1) to copy the parameters to the selected connectors.

You start the scheduling by closing the popup with the OK button.




37

6.1.4

Link Navigation Depending on UI Technology

In the Connector Administration Cockpit, you can define where a link from the search result list should open. The available UI technologies therefore have to be maintained. Choose System Settings Maintain UI Technologies and select the checkboxes in the corresponding popup. →

For activated entries, you can additionally specify the priority.

CUSTOMER

38




6.2

Using the Search and Analytics Modeler

You find the official, detailed documentation about the Search and Analytics Modeler in SAP Library. The modeler is mainly used to create your own search models or extend the models delivered by SAP. You open the Search and Analytics Modeler in a browser window via transaction ESH_MODELER. You can also access the modeler from the Administration Cockpit (see 6.1). On the left-hand side of the initial screen, you see the Software Components listed as folders (for example, SAPAPPLH). The sub-folders can be software components included in this higher-level software component (for example, SAP Business Suite Foundation Search on HANA - SBSFNDH) or application components for grouping the models (here PM), in which all corresponding models are collected.

6.2.1

Creating or Extending Search and Analysis Models

Detailed information about creating or extending an existing model delivered by SAP is described in the SAP Library under Technology Platform SAP NetWeaver 7.4 SAP NetWeaver Library: Function Oriented View →

Search and Operational Analytics Analysis Models.

→

→

Creating Search and Analysis Models

→

→

Creating or Extending Search and

→

The modeler guides you through all necessary steps to create or enhance a model. The picture below shows model EQUIPMENT_H of software component SAPAPPLH in display mode.




39

In the following section, some features of the modeler are described with relation to their influence on the UI. For technical details, refer to the SAP Library documentation about the Modeler mentioned above.

Step 1: Model Properties Here you can define a specific icon for each object type and define search categories (see chapter 5.3) in the search model.

Step 2: Model Nodes For TREX-based models, DDIC structures containing the node fields are used as the data source. For HANA-based search models, database tables of table type Column Store are used as the data sources. In the Attributes section of each node, you can specify a key, you can select the checkbox Contains Text (if the field value is a text string), and you can define a conversion routine. In the example below, the conversion routine ALPHA, which is entered for attribute ELIEF, suppresses the leading zeros in front of the vendor number.

CUSTOMER

40




Step 3: Node Relations On the Node Relations tab page of the ESH Modeler, you specify the cardinality and reverse cardinality of each individual node in relation to its superior node (1). If you select the checkbox in the Subquery table column, a folder for this subquery appears in the details of each single result line (2). In this example you see a folder with additional information for notification items, tasks, activities, and statuses in the details of the selected notification.

For detailed information about the rules that apply for cardinalities, see Defining Node Relationships in SAP Library.

Step 4: Model Requests If you select the checkbox in the Freestyle table column for an attribute, you can search for any string in the values of this attribute (1). The text t hat you enter as the attribute description is displayed as search criteria in the dropdown menu of the search UI (2). If you want an attribute to be used as a filter criterion on the left side of the search result list (3), you have to select the checkbox in the Interactive Navigation (Int. Nav.) table column.




41

Step 5: Node Response On the Authorization tab page, you can set the relevant ABAP authorization objects. We recommend that you include search software component SAP_BASIS for the user authorizations when you create a customer-specific component. On the Response Attributes tab page, you can specify in which UI area of the search results you want each attribute to appear. You can thus determine whether an attribute is to be displayed in the title, the summary, the details, the long text or on other parts of the search results list. In this example, the attribute Equipment Description will be displayed in the Summary and in the Details, but not in the Title.

CUSTOMER

42




On the Related Actions tab page, you can specify Related Requests. You can determine several subqueries that you can open via links in the summary of each search result item.

In addition to related requests, Navigation Targets are also displayed in the summary of the result list items. They provide links to applications you can navigate to, depending on the user interface (see 6.1.4). In this example, the UI Technology: Web Dynpro (Application Server) (1) is selected and four navigation IDs are defined. For each navigation target that you want to be displayed as a link in the footer of the summary, you have to provide a navigation instruction and a description that the system uses as link text (4). If you do not provide a navigation instruction, the navigation target is not displayed as link. In our example, the entry CBON has no navigation instruction provided and is therefore not displayed as a link (3), whereas the entries in lines three and four have navigation instructions and provide the links for Add to Favorites and Display Equipment in Asset Viewer . If you click on them in the results list, these functions are executed (4). For one of the navigation IDs you can select the Object Link radio button and thereby determine the navigation target of the summary title object. In our example, the Object Link radio button is selected for the DISPLAY_EQUIPMENT navigation ID (2). So if you click on it in the search results list, a separate Web Dynpro window opens and shows this piece of equipment in display mode.




43

For detailed information about the navigation targets, see Defining Node Responses in SAP Library.

6.2.2

Transport of Model Corrections

The transport of search model correction has changed from transporting table entries to transporting generated xml-like reports. This has the advantage that you now have a versioning of the respective report. For more information about Transporting Search Models, see SAP Library for SAP NetWeaver Platform on SAP Help Portal at http://help.sap.com/nw_platform. As a release, choose SAP NetWeaver 7.4. In the Application Help, choose Function-Oriented View Search and Operational Analytics Managing Search and Operational Analytics Technical Operations Manual Search-Specific Administration Tasks and Information . →

→

→

→

For questions and answers about transporting search models using the Note Assistant (SNOTE), see the very useful SAP note 1874091 - SNOTE: Frequently Asked Questions (ESH Program-Based Model Transport) , which contains a lot of background information. For error analysis in transport logs, refer to SAP note 2183657 - Analysis of import errors for report-based transport of Enterprise Search models.

6.3

Using Task Lists to Create and Index Connectors

For creating connectors and indices you can use a preconfigured task list called SAP_ESH_CREATE_INDEX_SC. Run the respective task list in STC01 for an entire software component (for example SAPAPPLH) or for a set of connectors. The connector names are entered as parameters in step 3 Select Models to Create Connectors (1). The task list can be started in the background (2).

To check the job log of the background job, use the Job Monitor. The job name is filled in automatically and the job can be entered by choosing Execute (F8).

CUSTOMER

44




In the Job Log, you can see the selected connectors, their status ( Indexing/ Active), the registration for real-time indexing, and at the end the success-message for the task list run.




45

7

Additional Documentation

7.1

NetWeaver 7.3 and Older

Up to SAP NetWeaver 7.3, the Embedded Search or Enterprise Search was known under the name SAP NetWeaver Enterprise Search and was treated as a part of SAP NetWeaver technology. You can find the c urrent documentation for SAP NetWeaver Enterprise Search on SAP Help Portal at Technology Platform SAP NetWeaver Enterprise Search 7.3. From here you can navigate to the following sections: →

→



What’s New – Release Notes



Installation and Upgrade Information



Getting Started with SAP NetWeaver Enterprise Search



Configuration and Deployment Information



Security Information



System Administration and Maintenance Information



Application Help



Development Information



Additional Information

7.2

Official Road Map

The official road map for Enterprise Search can be found on the SAP Service Marketplace at http://service.sap.com/saproadmaps. In the Database & Technology section, you can find the c urrent version of the road map SAP HANA enterprise search under the topic Platform.

7.3

SAP Notes

For quick access to SAP Notes via an internet browser, use URL address http://service.sap.com/sap/support/notes/. Add the respective note number in the placeholder .

2054157 - How to migrate Embedded Search from TREX to HANA? 2224527 - Embedded Search for SAP Fiori 2228932 - Release Information for SAP Enterprise Search 7.5 for SAP Fiori 1861013 - HANA-Enabled Search Models in the SAP Business Suite 2074166 - Cannot create index on expression with datatype LOB: Value_String 1730102 - Release Restrictions for SAP NetWeaver 7.4

CUSTOMER

46




7.4

SCN Blogs

You may find interesting blogs about Enterprise Search topics in the SAP Community Network under Enterprise Search (http://scn.sap.com/community/enterprise-search).

7.5

Guides and Wiki Links



HANA Search Developer guide 1.1 – March 2016



SCN-Blog with Developer Guide: Developer's Guide Enabling Business Objects for Embedded Search of Oct 2012





Wiki Home Page in SCN (https://wiki.scn.sap.com/wiki/display/WHP/Home) with page Technology Troubleshooting Guide Main Page under SAP NetWeaver you find Embedded Search TSG (2011) Wiki Home Page for BI ( https://wiki.scn.sap.com/wiki/display/BI/SAP+Business+Warehouse+Home ) SAP NetWeaver Business Warehouse SAP Business Warehouse Home Trex BC-EIM-ESH - Enterprise Search with Trouble Shooting Page. →



→

→

EAM Web UI Implementation Guide in SCN

7.6

Components for Incidents BC-EIM-ESH, PM-ESH

If you want to open a customer incident regarding the Enterprise Search, use component BC-EIM-ESH for issues concerning the search itself. For issues with the EAM search models, connectors, and results, use component PMESH. You can also search for SAP notes on these components.

7.7

Transaction Codes and Reports for ES

Transaction Codes for Enterprise Search Transaction Code

Short Text

ESH_ADM_SERVER_GROUP

Set Server Group

ESH_ADM_TREX_DEST

Set TREX Destination

ESH_COCKPIT

Connector Administration Cockpit

ESH_EXTR_USER

ESH Set Extraction User for Indexing

ESH_IMG

Customizing Enterprise Search

ESH_MODELER

Search & Analytics Modeler

ESH_QL_CUST

Customize Query Logging




47

ESH_QUERY_LOG

Enterprise Search Query Log

ESH_REG_REMSEARCH

Configuration of Remote Search

ESH_SEARCH

Enterprise Search UI (only ERP)

ESH_TEST_SEARCH

Test Search

Reports for Enterprise Search The following reports are available for the Enterprise Search (transaction SE38). 



You can use the report ESH_IEF_SNOTE__SHOW_IMPORT_ERR to display the error log when updates of search models are imported into a client. Enter the report name and the respective software component in transaction SE38 and execute the report.

You can use the report ESH_IEF_SNOTE__FIND_PROGRAM to find generated programs of the Enterprise Search. You can compare source and target systems to find missing programs. Enter the report name in transaction SE38, enter a search software component and search terms, and execute the report.







You can use the report ESH_EX_FU_CPOINTER_REORG to reorganize change pointers that are stored in table ESH_EX_CPOINTER. Make sure you have stopped real-time indexing in the Administration Cockpit before you execute the report. You can use the report ESH_EX_SET_EXTRACTION_USER to create a user with sufficient authorization for the data extraction. For more information, see SAP Note 1345160. If search models have been modified, the changes exist only in client 000 (or in the development system in the development client). You can use the report ESH_IEF_IMP_OM_UPDATE_CONTENT to propagate the changes to the testing client. Start the report for the respective search software component in transaction SE38 to transmit the changes to the client in which it is executed.

CUSTOMER

48




Guide for Enterprise Search in Enterprise Asset Management (EAM)

Recommend Documents